Network.AWS.RDS.Types

Service Configuration

rDS :: Service

API version '2014-10-31' of the Amazon Relational Database Service SDK configuration.

Errors

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

CertificateIdentifier does not refer to an existing certificate.

_ReservedDBInstanceQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

Request would exceed the user's DB Instance quota.

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

User already has a DB cluster snapshot with the given identifier.

_AuthorizationQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

DB security group authorization quota has been reached.

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

The requested source could not be found.

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

The DB parameter group cannot be deleted because it is in use.

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

A DB parameter group with the same name exists.

_PointInTimeRestoreNotEnabledFault :: AsError a => Getting (First ServiceError) a ServiceError

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

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

Request would result in user exceeding the allowed number of DB parameter groups.

_ProvisionedIOPSNotAvailableInAZFault :: AsError a => Getting (First ServiceError) a ServiceError

Provisioned IOPS not available in the specified Availability Zone.

_AuthorizationAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.

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

The DB cluster does not have enough capacity for the current operation.

_ReservedDBInstanceAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

User already has a reservation with the given identifier.

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

The supplied category does not exist.

_DBSubnetQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

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

The subscription name does not exist.

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

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

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

DBClusterIdentifier does not refer to an existing DB cluster.

_OptionGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified option group could not be found.

_DBLogFileNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

LogFileName does not refer to an existing DB log file.

_OptionGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

The option group you are trying to create already exists.

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

User already has a DB cluster with the given identifier.

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

StorageType specified cannot be associated with the DB Instance.

_DBSecurityGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

Request would result in user exceeding the allowed number of DB security groups.

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

DBSnapshotIdentifier does not refer to an existing DB snapshot.

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

This error can occur if someone else is modifying a subscription. You should retry the action.

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

Error accessing KMS key.

_OptionGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The quota of 20 option groups was exceeded for this AWS account.

_DBSecurityGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

A DB security group with the name specified in DBSecurityGroupName already exists.

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

Request would result in user exceeding the allowed number of DB snapshots.

_SNSTopicARNNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The SNS topic ARN does not exist.

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

User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

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

DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.

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

DBSubnetGroupName is already used by an existing DB subnet group.

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

Request would result in user exceeding the allowed number of DB instances.

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

You do not have permission to publish to the SNS topic ARN.

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

DBSecurityGroupName does not refer to an existing DB security group.

_DBSecurityGroupNotSupportedFault :: AsError a => Getting (First ServiceError) a ServiceError

A DB security group is not allowed for this action.

_DomainNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

Domain does not refer to an existing Active Directory Domain.

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

DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

_ReservedDBInstancesOfferingNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

Specified offering does not exist.

_InvalidDBSubnetGroupFault :: AsError a => Getting (First ServiceError) a ServiceError

Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.

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

The DB subnet is not in the available state.

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

DBParameterGroupName does not refer to an existing DB parameter group.

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

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

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

The supplied subscription name already exists.

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

The supplied value is not a valid DB cluster snapshot state.

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

Specified DB instance class is not available in the specified Availability Zone.

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

DB subnet group does not cover all Availability Zones after it is created because users' change.

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

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

RDS may not also be authorized via IAM to perform necessary actions on your behalf.

_ReservedDBInstanceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified reserved DB Instance not found.

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

Request would result in user exceeding the allowed number of DB subnet groups.

_DBSubnetGroupNotAllowedFault :: AsError a => Getting (First ServiceError) a ServiceError

Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.

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

You have reached the maximum number of event subscriptions.

_InvalidOptionGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The option group is not in the available state.

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

The supplied value is not a valid DB cluster state.

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

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

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

User already has a DB instance with the given identifier.

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

The specified resource ID was not found.

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

The DB upgrade failed because a resource the DB depends on could not be modified.

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

The state of the DB security group does not allow deletion.

_InsufficientDomainCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError

Requested Active Directory Domain has reached maximum number of instances.

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

DBSubnetGroupName does not refer to an existing DB subnet group.

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

Cannot restore from vpc backup to non-vpc DB instance.

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

The specified DB instance is not in the available state.

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

The state of the DB snapshot does not allow deletion.

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

The DB subnet group cannot be deleted because it is in use.

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

Request would result in user exceeding the allowed amount of storage available across all DB instances.

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

DBSnapshotIdentifier is already used by an existing snapshot.

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

DBInstanceIdentifier does not refer to an existing DB instance.

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

The DB subnet is already in use in the Availability Zone.

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

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

ApplyMethod

data ApplyMethod

Constructors

Immediate

PendingReboot

Instances

Enum ApplyMethod

Eq ApplyMethod

Data ApplyMethod

Ord ApplyMethod

Read ApplyMethod

Show ApplyMethod

Generic ApplyMethod

Hashable ApplyMethod

ToHeader ApplyMethod

FromXML ApplyMethod

ToQuery ApplyMethod

ToByteString ApplyMethod

FromText ApplyMethod

ToText ApplyMethod

Typeable * ApplyMethod

type Rep ApplyMethod

SourceType

data SourceType

Constructors

DBInstance

DBParameterGroup

DBSecurityGroup

DBSnapshot

Instances

Enum SourceType

Eq SourceType

Data SourceType

Ord SourceType

Read SourceType

Show SourceType

Generic SourceType

Hashable SourceType

ToHeader SourceType

FromXML SourceType

ToQuery SourceType

ToByteString SourceType

FromText SourceType

ToText SourceType

Typeable * SourceType

type Rep SourceType

AccountQuota

data AccountQuota

Describes a quota for an AWS account, for example, the number of DB instances allowed.

See: accountQuota smart constructor.

Instances

Eq AccountQuota

Data AccountQuota

Read AccountQuota

Show AccountQuota

Generic AccountQuota

FromXML AccountQuota

Typeable * AccountQuota

type Rep AccountQuota

accountQuota :: AccountQuota

Creates a value of AccountQuota with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aqMax
• aqUsed
• aqAccountQuotaName

aqMax :: Lens' AccountQuota (Maybe Integer)

The maximum allowed value for the quota.

aqUsed :: Lens' AccountQuota (Maybe Integer)

The amount currently used toward the quota maximum.

aqAccountQuotaName :: Lens' AccountQuota (Maybe Text)

The name of the Amazon RDS quota for this AWS account.

AvailabilityZone

data AvailabilityZone

Contains Availability Zone information.

This data type is used as an element in the following data type:

• OrderableDBInstanceOption

See: availabilityZone smart constructor.

Instances

Eq AvailabilityZone

Data AvailabilityZone

Read AvailabilityZone

Show AvailabilityZone

Generic AvailabilityZone

FromXML AvailabilityZone

Typeable * AvailabilityZone

type Rep AvailabilityZone

availabilityZone :: AvailabilityZone

Creates a value of AvailabilityZone with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• azName

azName :: Lens' AvailabilityZone (Maybe Text)

The name of the availability zone.

Certificate

data Certificate

A CA certificate for an AWS account.

See: certificate smart constructor.

Instances

Eq Certificate

Data Certificate

Read Certificate

Show Certificate

Generic Certificate

FromXML Certificate

Typeable * Certificate

type Rep Certificate

certificate :: Certificate

Creates a value of Certificate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cCertificateType
• cValidTill
• cCertificateIdentifier
• cThumbprint
• cValidFrom

cCertificateType :: Lens' Certificate (Maybe Text)

The type of the certificate.

cValidTill :: Lens' Certificate (Maybe UTCTime)

The final date that the certificate continues to be valid.

cCertificateIdentifier :: Lens' Certificate (Maybe Text)

The unique key that identifies a certificate.

cThumbprint :: Lens' Certificate (Maybe Text)

The thumbprint of the certificate.

cValidFrom :: Lens' Certificate (Maybe UTCTime)

The starting date from which the certificate is valid.

CharacterSet

data CharacterSet

This data type is used as a response element in the action DescribeDBEngineVersions.

See: characterSet smart constructor.

Instances

Eq CharacterSet

Data CharacterSet

Read CharacterSet

Show CharacterSet

Generic CharacterSet

FromXML CharacterSet

Typeable * CharacterSet

type Rep CharacterSet

characterSet :: CharacterSet

Creates a value of CharacterSet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csCharacterSetName
• csCharacterSetDescription

csCharacterSetName :: Lens' CharacterSet (Maybe Text)

The name of the character set.

csCharacterSetDescription :: Lens' CharacterSet (Maybe Text)

The description of the character set.

DBCluster

data DBCluster

Contains the result of a successful invocation of the following actions:

• CreateDBCluster
• DeleteDBCluster
• FailoverDBCluster
• ModifyDBCluster
• RestoreDBClusterFromSnapshot

This data type is used as a response element in the DescribeDBClusters action.

See: dbCluster smart constructor.

Instances

Eq DBCluster

Data DBCluster

Read DBCluster

Show DBCluster

Generic DBCluster

FromXML DBCluster

Typeable * DBCluster

type Rep DBCluster

dbCluster :: DBCluster

Creates a value of DBCluster with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcEngineVersion
• dcStatus
• dcDBClusterIdentifier
• dcDBClusterMembers
• dcDBClusterParameterGroup
• dcMasterUsername
• dcEarliestRestorableTime
• dcEngine
• dcLatestRestorableTime
• dcPreferredMaintenanceWindow
• dcCharacterSetName
• dcAvailabilityZones
• dcPreferredBackupWindow
• dcVPCSecurityGroups
• dcBackupRetentionPeriod
• dcDatabaseName
• dcDBSubnetGroup
• dcAllocatedStorage
• dcEndpoint
• dcPercentProgress
• dcPort
• dcDBClusterOptionGroupMemberships

dcEngineVersion :: Lens' DBCluster (Maybe Text)

Indicates the database engine version.

dcStatus :: Lens' DBCluster (Maybe Text)

Specifies the current state of this DB cluster.

dcDBClusterIdentifier :: Lens' DBCluster (Maybe Text)

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

dcDBClusterMembers :: Lens' DBCluster [DBClusterMember]

Provides the list of instances that make up the DB cluster.

dcDBClusterParameterGroup :: Lens' DBCluster (Maybe Text)

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

dcMasterUsername :: Lens' DBCluster (Maybe Text)

Contains the master username for the DB cluster.

dcEarliestRestorableTime :: Lens' DBCluster (Maybe UTCTime)

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

dcEngine :: Lens' DBCluster (Maybe Text)

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

dcLatestRestorableTime :: Lens' DBCluster (Maybe UTCTime)

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

dcPreferredMaintenanceWindow :: Lens' DBCluster (Maybe Text)

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

dcCharacterSetName :: Lens' DBCluster (Maybe Text)

If present, specifies the name of the character set that this cluster is associated with.

dcAvailabilityZones :: Lens' DBCluster [Text]

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

dcPreferredBackupWindow :: Lens' DBCluster (Maybe Text)

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

dcVPCSecurityGroups :: Lens' DBCluster [VPCSecurityGroupMembership]

Provides a list of VPC security groups that the DB cluster belongs to.

dcBackupRetentionPeriod :: Lens' DBCluster (Maybe Int)

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

dcDatabaseName :: Lens' DBCluster (Maybe Text)

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

dcDBSubnetGroup :: Lens' DBCluster (Maybe Text)

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

dcAllocatedStorage :: Lens' DBCluster (Maybe Int)

Specifies the allocated storage size in gigabytes (GB).

dcEndpoint :: Lens' DBCluster (Maybe Text)

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

dcPercentProgress :: Lens' DBCluster (Maybe Text)

Specifies the progress of the operation as a percentage.

dcPort :: Lens' DBCluster (Maybe Int)

Specifies the port that the database engine is listening on.

dcDBClusterOptionGroupMemberships :: Lens' DBCluster [DBClusterOptionGroupStatus]

Provides the list of option group memberships for this DB cluster.

DBClusterMember

data DBClusterMember

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

See: dbClusterMember smart constructor.

Instances

Eq DBClusterMember

Data DBClusterMember

Read DBClusterMember

Show DBClusterMember

Generic DBClusterMember

FromXML DBClusterMember

Typeable * DBClusterMember

type Rep DBClusterMember

dbClusterMember :: DBClusterMember

Creates a value of DBClusterMember with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcmDBInstanceIdentifier
• dcmIsClusterWriter
• dcmDBClusterParameterGroupStatus

dcmDBInstanceIdentifier :: Lens' DBClusterMember (Maybe Text)

Specifies the instance identifier for this member of the DB cluster.

dcmIsClusterWriter :: Lens' DBClusterMember (Maybe Bool)

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

dcmDBClusterParameterGroupStatus :: Lens' DBClusterMember (Maybe Text)

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

DBClusterOptionGroupStatus

data DBClusterOptionGroupStatus

Contains status information for a DB cluster option group.

See: dbClusterOptionGroupStatus smart constructor.

Instances

Eq DBClusterOptionGroupStatus

Data DBClusterOptionGroupStatus

Read DBClusterOptionGroupStatus

Show DBClusterOptionGroupStatus

Generic DBClusterOptionGroupStatus

FromXML DBClusterOptionGroupStatus

Typeable * DBClusterOptionGroupStatus

type Rep DBClusterOptionGroupStatus

dbClusterOptionGroupStatus :: DBClusterOptionGroupStatus

Creates a value of DBClusterOptionGroupStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcogsStatus
• dcogsDBClusterOptionGroupName

dcogsStatus :: Lens' DBClusterOptionGroupStatus (Maybe Text)

Specifies the status of the DB cluster option group.

dcogsDBClusterOptionGroupName :: Lens' DBClusterOptionGroupStatus (Maybe Text)

Specifies the name of the DB cluster option group.

DBClusterParameterGroup

data DBClusterParameterGroup

Contains the result of a successful invocation of the CreateDBClusterParameterGroup action.

This data type is used as a request parameter in the DeleteDBClusterParameterGroup action, and as a response element in the DescribeDBClusterParameterGroups action.

See: dbClusterParameterGroup smart constructor.

Instances

Eq DBClusterParameterGroup

Data DBClusterParameterGroup

Read DBClusterParameterGroup

Show DBClusterParameterGroup

Generic DBClusterParameterGroup

FromXML DBClusterParameterGroup

Typeable * DBClusterParameterGroup

type Rep DBClusterParameterGroup

dbClusterParameterGroup :: DBClusterParameterGroup

Creates a value of DBClusterParameterGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcpgDBParameterGroupFamily
• dcpgDBClusterParameterGroupName
• dcpgDescription

dcpgDBParameterGroupFamily :: Lens' DBClusterParameterGroup (Maybe Text)

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

dcpgDBClusterParameterGroupName :: Lens' DBClusterParameterGroup (Maybe Text)

Provides the name of the DB cluster parameter group.

dcpgDescription :: Lens' DBClusterParameterGroup (Maybe Text)

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

DBClusterParameterGroupNameMessage

data DBClusterParameterGroupNameMessage

See: dbClusterParameterGroupNameMessage smart constructor.

Instances

Eq DBClusterParameterGroupNameMessage

Data DBClusterParameterGroupNameMessage

Read DBClusterParameterGroupNameMessage

Show DBClusterParameterGroupNameMessage

Generic DBClusterParameterGroupNameMessage

FromXML DBClusterParameterGroupNameMessage

Typeable * DBClusterParameterGroupNameMessage

type Rep DBClusterParameterGroupNameMessage

dbClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage

Creates a value of DBClusterParameterGroupNameMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcpgnmDBClusterParameterGroupName

dcpgnmDBClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text)

The name of the DB cluster parameter group.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

DBClusterSnapshot

data DBClusterSnapshot

Contains the result of a successful invocation of the following actions:

• CreateDBClusterSnapshot
• DeleteDBClusterSnapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

See: dbClusterSnapshot smart constructor.

Instances

Eq DBClusterSnapshot

Data DBClusterSnapshot

Read DBClusterSnapshot

Show DBClusterSnapshot

Generic DBClusterSnapshot

FromXML DBClusterSnapshot

Typeable * DBClusterSnapshot

type Rep DBClusterSnapshot

dbClusterSnapshot :: DBClusterSnapshot

Creates a value of DBClusterSnapshot with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcsEngineVersion
• dcsStatus
• dcsDBClusterIdentifier
• dcsMasterUsername
• dcsVPCId
• dcsDBClusterSnapshotIdentifier
• dcsEngine
• dcsLicenseModel
• dcsSnapshotType
• dcsAvailabilityZones
• dcsSnapshotCreateTime
• dcsAllocatedStorage
• dcsClusterCreateTime
• dcsPercentProgress
• dcsPort

dcsEngineVersion :: Lens' DBClusterSnapshot (Maybe Text)

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

dcsStatus :: Lens' DBClusterSnapshot (Maybe Text)

Specifies the status of this DB cluster snapshot.

dcsDBClusterIdentifier :: Lens' DBClusterSnapshot (Maybe Text)

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

dcsMasterUsername :: Lens' DBClusterSnapshot (Maybe Text)

Provides the master username for the DB cluster snapshot.

dcsVPCId :: Lens' DBClusterSnapshot (Maybe Text)

Provides the VPC ID associated with the DB cluster snapshot.

dcsDBClusterSnapshotIdentifier :: Lens' DBClusterSnapshot (Maybe Text)

Specifies the identifier for the DB cluster snapshot.

dcsEngine :: Lens' DBClusterSnapshot (Maybe Text)

Specifies the name of the database engine.

dcsLicenseModel :: Lens' DBClusterSnapshot (Maybe Text)

Provides the license model information for this DB cluster snapshot.

dcsSnapshotType :: Lens' DBClusterSnapshot (Maybe Text)

Provides the type of the DB cluster snapshot.

dcsAvailabilityZones :: Lens' DBClusterSnapshot [Text]

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

dcsSnapshotCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime)

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

dcsAllocatedStorage :: Lens' DBClusterSnapshot (Maybe Int)

Specifies the allocated storage size in gigabytes (GB).

dcsClusterCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime)

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

dcsPercentProgress :: Lens' DBClusterSnapshot (Maybe Int)

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

dcsPort :: Lens' DBClusterSnapshot (Maybe Int)

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

DBEngineVersion

data DBEngineVersion

This data type is used as a response element in the action DescribeDBEngineVersions.

See: dbEngineVersion smart constructor.

Instances

Eq DBEngineVersion

Data DBEngineVersion

Read DBEngineVersion

Show DBEngineVersion

Generic DBEngineVersion

FromXML DBEngineVersion

Typeable * DBEngineVersion

type Rep DBEngineVersion

dbEngineVersion :: DBEngineVersion

Creates a value of DBEngineVersion with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• devDBEngineVersionDescription
• devEngineVersion
• devDefaultCharacterSet
• devSupportedCharacterSets
• devEngine
• devDBParameterGroupFamily
• devDBEngineDescription

devDBEngineVersionDescription :: Lens' DBEngineVersion (Maybe Text)

The description of the database engine version.

devEngineVersion :: Lens' DBEngineVersion (Maybe Text)

The version number of the database engine.

devDefaultCharacterSet :: Lens' DBEngineVersion (Maybe CharacterSet)

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

devSupportedCharacterSets :: Lens' DBEngineVersion [CharacterSet]

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.

devEngine :: Lens' DBEngineVersion (Maybe Text)

The name of the database engine.

devDBParameterGroupFamily :: Lens' DBEngineVersion (Maybe Text)

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

devDBEngineDescription :: Lens' DBEngineVersion (Maybe Text)

The description of the database engine.

DBInstance

data DBInstance

Contains the result of a successful invocation of the following actions:

• CreateDBInstance
• DeleteDBInstance
• ModifyDBInstance

This data type is used as a response element in the DescribeDBInstances action.

See: dbInstance smart constructor.

Instances

Eq DBInstance

Data DBInstance

Read DBInstance

Show DBInstance

Generic DBInstance

FromXML DBInstance

Typeable * DBInstance

type Rep DBInstance

dbInstance :: DBInstance

Creates a value of DBInstance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• diDBSecurityGroups
• diEngineVersion
• diStorageEncrypted
• diDBClusterIdentifier
• diAutoMinorVersionUpgrade
• diMasterUsername
• diPubliclyAccessible
• diReadReplicaDBInstanceIdentifiers
• diIOPS
• diInstanceCreateTime
• diReadReplicaSourceDBInstanceIdentifier
• diEngine
• diLatestRestorableTime
• diDBInstanceClass
• diLicenseModel
• diPreferredMaintenanceWindow
• diCharacterSetName
• diDBInstanceIdentifier
• diCACertificateIdentifier
• diPreferredBackupWindow
• diAvailabilityZone
• diVPCSecurityGroups
• diBackupRetentionPeriod
• diKMSKeyId
• diDBSubnetGroup
• diMultiAZ
• diSecondaryAvailabilityZone
• diOptionGroupMemberships
• diDBiResourceId
• diAllocatedStorage
• diEndpoint
• diDBParameterGroups
• diTDECredentialARN
• diCopyTagsToSnapshot
• diDBInstanceStatus
• diDBInstancePort
• diPendingModifiedValues
• diStatusInfos
• diDBName
• diDomainMemberships
• diStorageType

diDBSecurityGroups :: Lens' DBInstance [DBSecurityGroupMembership]

Provides List of DB security group elements containing only Name and Status subelements.

diEngineVersion :: Lens' DBInstance (Maybe Text)

Indicates the database engine version.

diStorageEncrypted :: Lens' DBInstance (Maybe Bool)

Specifies whether the DB instance is encrypted.

diDBClusterIdentifier :: Lens' DBInstance (Maybe Text)

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

diAutoMinorVersionUpgrade :: Lens' DBInstance (Maybe Bool)

Indicates that minor version patches are applied automatically.

diMasterUsername :: Lens' DBInstance (Maybe Text)

Contains the master username for the DB instance.

diPubliclyAccessible :: Lens' DBInstance (Maybe Bool)

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

diReadReplicaDBInstanceIdentifiers :: Lens' DBInstance [Text]

Contains one or more identifiers of the Read Replicas associated with this DB instance.

diIOPS :: Lens' DBInstance (Maybe Int)

Specifies the Provisioned IOPS (I/O operations per second) value.

diInstanceCreateTime :: Lens' DBInstance (Maybe UTCTime)

Provides the date and time the DB instance was created.

diReadReplicaSourceDBInstanceIdentifier :: Lens' DBInstance (Maybe Text)

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

diEngine :: Lens' DBInstance (Maybe Text)

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

diLatestRestorableTime :: Lens' DBInstance (Maybe UTCTime)

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

diDBInstanceClass :: Lens' DBInstance (Maybe Text)

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

diLicenseModel :: Lens' DBInstance (Maybe Text)

License model information for this DB instance.

diPreferredMaintenanceWindow :: Lens' DBInstance (Maybe Text)

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

diCharacterSetName :: Lens' DBInstance (Maybe Text)

If present, specifies the name of the character set that this instance is associated with.

diDBInstanceIdentifier :: Lens' DBInstance (Maybe Text)

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

diCACertificateIdentifier :: Lens' DBInstance (Maybe Text)

The identifier of the CA certificate for this DB instance.

diPreferredBackupWindow :: Lens' DBInstance (Maybe Text)

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

diAvailabilityZone :: Lens' DBInstance (Maybe Text)

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

diVPCSecurityGroups :: Lens' DBInstance [VPCSecurityGroupMembership]

Provides List of VPC security group elements that the DB instance belongs to.

diBackupRetentionPeriod :: Lens' DBInstance (Maybe Int)

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

diKMSKeyId :: Lens' DBInstance (Maybe Text)

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

diDBSubnetGroup :: Lens' DBInstance (Maybe DBSubnetGroup)

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

diMultiAZ :: Lens' DBInstance (Maybe Bool)

Specifies if the DB instance is a Multi-AZ deployment.

diSecondaryAvailabilityZone :: Lens' DBInstance (Maybe Text)

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

diOptionGroupMemberships :: Lens' DBInstance [OptionGroupMembership]

Provides the list of option group memberships for this DB instance.

diDBiResourceId :: Lens' DBInstance (Maybe Text)

If StorageEncrypted is true, the region-unique, immutable identifier for the encrypted DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.

diAllocatedStorage :: Lens' DBInstance (Maybe Int)

Specifies the allocated storage size specified in gigabytes.

diEndpoint :: Lens' DBInstance (Maybe Endpoint)

Specifies the connection endpoint.

diDBParameterGroups :: Lens' DBInstance [DBParameterGroupStatus]

Provides the list of DB parameter groups applied to this DB instance.

diTDECredentialARN :: Lens' DBInstance (Maybe Text)

The ARN from the Key Store with which the instance is associated for TDE encryption.

diCopyTagsToSnapshot :: Lens' DBInstance (Maybe Bool)

This property is not currently implemented.

diDBInstanceStatus :: Lens' DBInstance (Maybe Text)

Specifies the current state of this database.

diDBInstancePort :: Lens' DBInstance (Maybe Int)

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

diPendingModifiedValues :: Lens' DBInstance (Maybe PendingModifiedValues)

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

diStatusInfos :: Lens' DBInstance [DBInstanceStatusInfo]

The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

diDBName :: Lens' DBInstance (Maybe Text)

The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.

MySQL, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

diDomainMemberships :: Lens' DBInstance [DomainMembership]

The Active Directory Domain membership records associated with the DB instance.

diStorageType :: Lens' DBInstance (Maybe Text)

Specifies the storage type associated with DB instance.

DBInstanceStatusInfo

data DBInstanceStatusInfo

Provides a list of status information for a DB instance.

See: dbInstanceStatusInfo smart constructor.

Instances

Eq DBInstanceStatusInfo

Data DBInstanceStatusInfo

Read DBInstanceStatusInfo

Show DBInstanceStatusInfo

Generic DBInstanceStatusInfo

FromXML DBInstanceStatusInfo

Typeable * DBInstanceStatusInfo

type Rep DBInstanceStatusInfo

dbInstanceStatusInfo :: DBInstanceStatusInfo

Creates a value of DBInstanceStatusInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• disiStatus
• disiNormal
• disiStatusType
• disiMessage

disiStatus :: Lens' DBInstanceStatusInfo (Maybe Text)

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

disiNormal :: Lens' DBInstanceStatusInfo (Maybe Bool)

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

disiStatusType :: Lens' DBInstanceStatusInfo (Maybe Text)

This value is currently "read replication."

disiMessage :: Lens' DBInstanceStatusInfo (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.

DBParameterGroup

data DBParameterGroup

Contains the result of a successful invocation of the CreateDBParameterGroup action.

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

See: dbParameterGroup smart constructor.

Instances

Eq DBParameterGroup

Data DBParameterGroup

Read DBParameterGroup

Show DBParameterGroup

Generic DBParameterGroup

FromXML DBParameterGroup

Typeable * DBParameterGroup

type Rep DBParameterGroup

dbParameterGroup :: DBParameterGroup

Creates a value of DBParameterGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dpgDBParameterGroupFamily
• dpgDBParameterGroupName
• dpgDescription

dpgDBParameterGroupFamily :: Lens' DBParameterGroup (Maybe Text)

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

dpgDBParameterGroupName :: Lens' DBParameterGroup (Maybe Text)

Provides the name of the DB parameter group.

dpgDescription :: Lens' DBParameterGroup (Maybe Text)

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

DBParameterGroupNameMessage

data DBParameterGroupNameMessage

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

See: dbParameterGroupNameMessage smart constructor.

Instances

Eq DBParameterGroupNameMessage

Data DBParameterGroupNameMessage

Read DBParameterGroupNameMessage

Show DBParameterGroupNameMessage

Generic DBParameterGroupNameMessage

FromXML DBParameterGroupNameMessage

Typeable * DBParameterGroupNameMessage

type Rep DBParameterGroupNameMessage

dbParameterGroupNameMessage :: DBParameterGroupNameMessage

Creates a value of DBParameterGroupNameMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dpgnmDBParameterGroupName

dpgnmDBParameterGroupName :: Lens' DBParameterGroupNameMessage (Maybe Text)

Provides the name of the DB parameter group.

DBParameterGroupStatus

data DBParameterGroupStatus

The status of the DB parameter group.

This data type is used as a response element in the following actions:

• CreateDBInstance
• CreateDBInstanceReadReplica
• DeleteDBInstance
• ModifyDBInstance
• RebootDBInstance
• RestoreDBInstanceFromDBSnapshot

See: dbParameterGroupStatus smart constructor.

Instances

Eq DBParameterGroupStatus

Data DBParameterGroupStatus

Read DBParameterGroupStatus

Show DBParameterGroupStatus

Generic DBParameterGroupStatus

FromXML DBParameterGroupStatus

Typeable * DBParameterGroupStatus

type Rep DBParameterGroupStatus

dbParameterGroupStatus :: DBParameterGroupStatus

Creates a value of DBParameterGroupStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dpgsDBParameterGroupName
• dpgsParameterApplyStatus

dpgsDBParameterGroupName :: Lens' DBParameterGroupStatus (Maybe Text)

The name of the DP parameter group.

dpgsParameterApplyStatus :: Lens' DBParameterGroupStatus (Maybe Text)

The status of parameter updates.

DBSecurityGroup

data DBSecurityGroup

Contains the result of a successful invocation of the following actions:

• DescribeDBSecurityGroups
• AuthorizeDBSecurityGroupIngress
• CreateDBSecurityGroup
• RevokeDBSecurityGroupIngress

This data type is used as a response element in the DescribeDBSecurityGroups action.

See: dbSecurityGroup smart constructor.

Instances

Eq DBSecurityGroup

Data DBSecurityGroup

Read DBSecurityGroup

Show DBSecurityGroup

Generic DBSecurityGroup

FromXML DBSecurityGroup

Typeable * DBSecurityGroup

type Rep DBSecurityGroup

dbSecurityGroup :: DBSecurityGroup

Creates a value of DBSecurityGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dsgVPCId
• dsgOwnerId
• dsgIPRanges
• dsgDBSecurityGroupName
• dsgEC2SecurityGroups
• dsgDBSecurityGroupDescription

dsgVPCId :: Lens' DBSecurityGroup (Maybe Text)

Provides the VpcId of the DB security group.

dsgOwnerId :: Lens' DBSecurityGroup (Maybe Text)

Provides the AWS ID of the owner of a specific DB security group.

dsgIPRanges :: Lens' DBSecurityGroup [IPRange]

Contains a list of IPRange elements.

dsgDBSecurityGroupName :: Lens' DBSecurityGroup (Maybe Text)

Specifies the name of the DB security group.

dsgEC2SecurityGroups :: Lens' DBSecurityGroup [EC2SecurityGroup]

Contains a list of EC2SecurityGroup elements.

dsgDBSecurityGroupDescription :: Lens' DBSecurityGroup (Maybe Text)

Provides the description of the DB security group.

DBSecurityGroupMembership

data DBSecurityGroupMembership

This data type is used as a response element in the following actions:

• ModifyDBInstance
• RebootDBInstance
• RestoreDBInstanceFromDBSnapshot
• RestoreDBInstanceToPointInTime

See: dbSecurityGroupMembership smart constructor.

Instances

Eq DBSecurityGroupMembership

Data DBSecurityGroupMembership

Read DBSecurityGroupMembership

Show DBSecurityGroupMembership

Generic DBSecurityGroupMembership

FromXML DBSecurityGroupMembership

Typeable * DBSecurityGroupMembership

type Rep DBSecurityGroupMembership

dbSecurityGroupMembership :: DBSecurityGroupMembership

Creates a value of DBSecurityGroupMembership with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dsgmStatus
• dsgmDBSecurityGroupName

dsgmStatus :: Lens' DBSecurityGroupMembership (Maybe Text)

The status of the DB security group.

dsgmDBSecurityGroupName :: Lens' DBSecurityGroupMembership (Maybe Text)

The name of the DB security group.

DBSnapshot

data DBSnapshot

Contains the result of a successful invocation of the following actions:

• CreateDBSnapshot
• DeleteDBSnapshot

This data type is used as a response element in the DescribeDBSnapshots action.

See: dbSnapshot smart constructor.

Instances

Eq DBSnapshot

Data DBSnapshot

Read DBSnapshot

Show DBSnapshot

Generic DBSnapshot

FromXML DBSnapshot

Typeable * DBSnapshot

type Rep DBSnapshot

dbSnapshot :: DBSnapshot

Creates a value of DBSnapshot with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dsEngineVersion
• dsStatus
• dsMasterUsername
• dsSourceRegion
• dsIOPS
• dsInstanceCreateTime
• dsVPCId
• dsEngine
• dsEncrypted
• dsDBSnapshotIdentifier
• dsLicenseModel
• dsSnapshotType
• dsDBInstanceIdentifier
• dsSourceDBSnapshotIdentifier
• dsAvailabilityZone
• dsKMSKeyId
• dsSnapshotCreateTime
• dsAllocatedStorage
• dsTDECredentialARN
• dsOptionGroupName
• dsPercentProgress
• dsPort
• dsStorageType

dsEngineVersion :: Lens' DBSnapshot (Maybe Text)

Specifies the version of the database engine.

dsStatus :: Lens' DBSnapshot (Maybe Text)

Specifies the status of this DB snapshot.

dsMasterUsername :: Lens' DBSnapshot (Maybe Text)

Provides the master username for the DB snapshot.

dsSourceRegion :: Lens' DBSnapshot (Maybe Text)

The region that the DB snapshot was created in or copied from.

dsIOPS :: Lens' DBSnapshot (Maybe Int)

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

dsInstanceCreateTime :: Lens' DBSnapshot (Maybe UTCTime)

Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).

dsVPCId :: Lens' DBSnapshot (Maybe Text)

Provides the VPC ID associated with the DB snapshot.

dsEngine :: Lens' DBSnapshot (Maybe Text)

Specifies the name of the database engine.

dsEncrypted :: Lens' DBSnapshot (Maybe Bool)

Specifies whether the DB snapshot is encrypted.

dsDBSnapshotIdentifier :: Lens' DBSnapshot (Maybe Text)

Specifies the identifier for the DB snapshot.

dsLicenseModel :: Lens' DBSnapshot (Maybe Text)

License model information for the restored DB instance.

dsSnapshotType :: Lens' DBSnapshot (Maybe Text)

Provides the type of the DB snapshot.

dsDBInstanceIdentifier :: Lens' DBSnapshot (Maybe Text)

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

dsSourceDBSnapshotIdentifier :: Lens' DBSnapshot (Maybe Text)

The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.

dsAvailabilityZone :: Lens' DBSnapshot (Maybe Text)

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

dsKMSKeyId :: Lens' DBSnapshot (Maybe Text)

If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

dsSnapshotCreateTime :: Lens' DBSnapshot (Maybe UTCTime)

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

dsAllocatedStorage :: Lens' DBSnapshot (Maybe Int)

Specifies the allocated storage size in gigabytes (GB).

dsTDECredentialARN :: Lens' DBSnapshot (Maybe Text)

The ARN from the Key Store with which to associate the instance for TDE encryption.

dsOptionGroupName :: Lens' DBSnapshot (Maybe Text)

Provides the option group name for the DB snapshot.

dsPercentProgress :: Lens' DBSnapshot (Maybe Int)

The percentage of the estimated data that has been transferred.

dsPort :: Lens' DBSnapshot (Maybe Int)

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

dsStorageType :: Lens' DBSnapshot (Maybe Text)

Specifies the storage type associated with DB Snapshot.

DBSubnetGroup

data DBSubnetGroup

Contains the result of a successful invocation of the following actions:

• CreateDBSubnetGroup
• ModifyDBSubnetGroup
• DescribeDBSubnetGroups
• DeleteDBSubnetGroup

This data type is used as a response element in the DescribeDBSubnetGroups action.

See: dbSubnetGroup smart constructor.

Instances

Eq DBSubnetGroup

Data DBSubnetGroup

Read DBSubnetGroup

Show DBSubnetGroup

Generic DBSubnetGroup

FromXML DBSubnetGroup

Typeable * DBSubnetGroup

type Rep DBSubnetGroup

dbSubnetGroup :: DBSubnetGroup

Creates a value of DBSubnetGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dbsgDBSubnetGroupName
• dbsgVPCId
• dbsgSubnets
• dbsgDBSubnetGroupDescription
• dbsgSubnetGroupStatus

dbsgDBSubnetGroupName :: Lens' DBSubnetGroup (Maybe Text)

Specifies the name of the DB subnet group.

dbsgVPCId :: Lens' DBSubnetGroup (Maybe Text)

Provides the VpcId of the DB subnet group.

dbsgSubnets :: Lens' DBSubnetGroup [Subnet]

Contains a list of Subnet elements.

dbsgDBSubnetGroupDescription :: Lens' DBSubnetGroup (Maybe Text)

Provides the description of the DB subnet group.

dbsgSubnetGroupStatus :: Lens' DBSubnetGroup (Maybe Text)

Provides the status of the DB subnet group.

DescribeDBLogFilesDetails

data DescribeDBLogFilesDetails

This data type is used as a response element to DescribeDBLogFiles.

See: describeDBLogFilesDetails smart constructor.

Instances

Eq DescribeDBLogFilesDetails

Data DescribeDBLogFilesDetails

Read DescribeDBLogFilesDetails

Show DescribeDBLogFilesDetails

Generic DescribeDBLogFilesDetails

FromXML DescribeDBLogFilesDetails

Typeable * DescribeDBLogFilesDetails

type Rep DescribeDBLogFilesDetails

describeDBLogFilesDetails :: DescribeDBLogFilesDetails

Creates a value of DescribeDBLogFilesDetails with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddlfdLastWritten
• ddlfdSize
• ddlfdLogFileName

ddlfdLastWritten :: Lens' DescribeDBLogFilesDetails (Maybe Integer)

A POSIX timestamp when the last log entry was written.

ddlfdSize :: Lens' DescribeDBLogFilesDetails (Maybe Integer)

The size, in bytes, of the log file for the specified DB instance.

ddlfdLogFileName :: Lens' DescribeDBLogFilesDetails (Maybe Text)

The name of the log file for the specified DB instance.

DomainMembership

data DomainMembership

An Active Directory Domain membership record associated with the DB instance.

See: domainMembership smart constructor.

Instances

Eq DomainMembership

Data DomainMembership

Read DomainMembership

Show DomainMembership

Generic DomainMembership

FromXML DomainMembership

Typeable * DomainMembership

type Rep DomainMembership

domainMembership :: DomainMembership

Creates a value of DomainMembership with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dmStatus
• dmDomain
• dmConnectivity

dmStatus :: Lens' DomainMembership (Maybe Text)

The status of the DB instance's Active Directory Domain membership (e.g. joined, pending-join, failed etc).

dmDomain :: Lens' DomainMembership (Maybe Text)

The identifier of the Active Directory Domain.

dmConnectivity :: Lens' DomainMembership (Maybe Text)

The observed connectivity of the Active Directory Domain.

EC2SecurityGroup

data EC2SecurityGroup

This data type is used as a response element in the following actions:

• AuthorizeDBSecurityGroupIngress
• DescribeDBSecurityGroups
• RevokeDBSecurityGroupIngress

See: ec2SecurityGroup smart constructor.

Instances

Eq EC2SecurityGroup

Data EC2SecurityGroup

Read EC2SecurityGroup

Show EC2SecurityGroup

Generic EC2SecurityGroup

FromXML EC2SecurityGroup

Typeable * EC2SecurityGroup

type Rep EC2SecurityGroup

ec2SecurityGroup :: EC2SecurityGroup

Creates a value of EC2SecurityGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• esgStatus
• esgEC2SecurityGroupOwnerId
• esgEC2SecurityGroupName
• esgEC2SecurityGroupId

esgStatus :: Lens' EC2SecurityGroup (Maybe Text)

Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

esgEC2SecurityGroupOwnerId :: Lens' EC2SecurityGroup (Maybe Text)

Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

esgEC2SecurityGroupName :: Lens' EC2SecurityGroup (Maybe Text)

Specifies the name of the EC2 security group.

esgEC2SecurityGroupId :: Lens' EC2SecurityGroup (Maybe Text)

Specifies the id of the EC2 security group.

Endpoint

data Endpoint

This data type is used as a response element in the following actions:

• CreateDBInstance
• DescribeDBInstances
• DeleteDBInstance

See: endpoint smart constructor.

Instances

Eq Endpoint

Data Endpoint

Read Endpoint

Show Endpoint

Generic Endpoint

FromXML Endpoint

Typeable * Endpoint

type Rep Endpoint

endpoint :: Endpoint

Creates a value of Endpoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eAddress
• ePort

eAddress :: Lens' Endpoint (Maybe Text)

Specifies the DNS address of the DB instance.

ePort :: Lens' Endpoint (Maybe Int)

Specifies the port that the database engine is listening on.

EngineDefaults

data EngineDefaults

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

See: engineDefaults smart constructor.

Instances

Eq EngineDefaults

Data EngineDefaults

Read EngineDefaults

Show EngineDefaults

Generic EngineDefaults

FromXML EngineDefaults

Typeable * EngineDefaults

type Rep EngineDefaults

engineDefaults :: EngineDefaults

Creates a value of EngineDefaults with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• edDBParameterGroupFamily
• edParameters
• edMarker

edDBParameterGroupFamily :: Lens' EngineDefaults (Maybe Text)

Specifies the name of the DB parameter group family that the engine default parameters apply to.

edParameters :: Lens' EngineDefaults [Parameter]

Contains a list of engine default parameters.

edMarker :: Lens' EngineDefaults (Maybe Text)

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

Event

data Event

This data type is used as a response element in the DescribeEvents action.

See: event smart constructor.

Instances

Eq Event

Data Event

Read Event

Show Event

Generic Event

FromXML Event

Typeable * Event

type Rep Event

event :: Event

Creates a value of Event with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eSourceType
• eSourceIdentifier
• eDate
• eEventCategories
• eMessage

eSourceType :: Lens' Event (Maybe SourceType)

Specifies the source type for this event.

eSourceIdentifier :: Lens' Event (Maybe Text)

Provides the identifier for the source of the event.

eDate :: Lens' Event (Maybe UTCTime)

Specifies the date and time of the event.

eEventCategories :: Lens' Event [Text]

Specifies the category for the event.

eMessage :: Lens' Event (Maybe Text)

Provides the text of this event.

EventCategoriesMap

data EventCategoriesMap

Contains the results of a successful invocation of the DescribeEventCategories action.

See: eventCategoriesMap smart constructor.

Instances

Eq EventCategoriesMap

Data EventCategoriesMap

Read EventCategoriesMap

Show EventCategoriesMap

Generic EventCategoriesMap

FromXML EventCategoriesMap

Typeable * EventCategoriesMap

type Rep EventCategoriesMap

eventCategoriesMap :: EventCategoriesMap

Creates a value of EventCategoriesMap with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ecmSourceType
• ecmEventCategories

ecmSourceType :: Lens' EventCategoriesMap (Maybe Text)

The source type that the returned categories belong to

ecmEventCategories :: Lens' EventCategoriesMap [Text]

The event categories for the specified source type

EventSubscription

data EventSubscription

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

See: eventSubscription smart constructor.

Instances

Eq EventSubscription

Data EventSubscription

Read EventSubscription

Show EventSubscription

Generic EventSubscription

FromXML EventSubscription

Typeable * EventSubscription

type Rep EventSubscription

eventSubscription :: EventSubscription

Creates a value of EventSubscription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• esCustomerAWSId
• esStatus
• esCustSubscriptionId
• esSNSTopicARN
• esEnabled
• esSourceType
• esSubscriptionCreationTime
• esEventCategoriesList
• esSourceIdsList

esCustomerAWSId :: Lens' EventSubscription (Maybe Text)

The AWS customer account associated with the RDS event notification subscription.

esStatus :: Lens' EventSubscription (Maybe Text)

The status of the RDS event notification subscription.

Constraints:

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

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

esCustSubscriptionId :: Lens' EventSubscription (Maybe Text)

The RDS event notification subscription Id.

esSNSTopicARN :: Lens' EventSubscription (Maybe Text)

The topic ARN of the RDS event notification subscription.

esEnabled :: Lens' EventSubscription (Maybe Bool)

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

esSourceType :: Lens' EventSubscription (Maybe Text)

The source type for the RDS event notification subscription.

esSubscriptionCreationTime :: Lens' EventSubscription (Maybe Text)

The time the RDS event notification subscription was created.

esEventCategoriesList :: Lens' EventSubscription [Text]

A list of event categories for the RDS event notification subscription.

esSourceIdsList :: Lens' EventSubscription [Text]

A list of source IDs for the RDS event notification subscription.

Filter

data Filter

See: filter' smart constructor.

Instances

Eq Filter

Data Filter

Read Filter

Show Filter

Generic Filter

ToQuery Filter

Typeable * Filter

type Rep Filter

filter'

Arguments

:: Text

fName

-> Filter

Creates a value of Filter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• fName
• fValues

fName :: Lens' Filter Text

This parameter is not currently supported.

fValues :: Lens' Filter [Text]

This parameter is not currently supported.

IPRange

data IPRange

This data type is used as a response element in the DescribeDBSecurityGroups action.

See: ipRange smart constructor.

Instances

Eq IPRange

Data IPRange

Read IPRange

Show IPRange

Generic IPRange

FromXML IPRange

Typeable * IPRange

type Rep IPRange

ipRange :: IPRange

Creates a value of IPRange with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• irStatus
• irCIdRIP

irStatus :: Lens' IPRange (Maybe Text)

Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

irCIdRIP :: Lens' IPRange (Maybe Text)

Specifies the IP range.

Option

data Option

Option details.

See: option smart constructor.

Instances

Eq Option

Data Option

Read Option

Show Option

Generic Option

FromXML Option

Typeable * Option

type Rep Option

option :: Option

Creates a value of Option with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• oOptionName
• oPermanent
• oPersistent
• oOptionDescription
• oOptionSettings
• oVPCSecurityGroupMemberships
• oDBSecurityGroupMemberships
• oPort

oOptionName :: Lens' Option (Maybe Text)

The name of the option.

oPermanent :: Lens' Option (Maybe Bool)

Indicate if this option is permanent.

oPersistent :: Lens' Option (Maybe Bool)

Indicate if this option is persistent.

oOptionDescription :: Lens' Option (Maybe Text)

The description of the option.

oOptionSettings :: Lens' Option [OptionSetting]

The option settings for this option.

oVPCSecurityGroupMemberships :: Lens' Option [VPCSecurityGroupMembership]

If the option requires access to a port, then this VPC security group allows access to the port.

oDBSecurityGroupMemberships :: Lens' Option [DBSecurityGroupMembership]

If the option requires access to a port, then this DB security group allows access to the port.

oPort :: Lens' Option (Maybe Int)

If required, the port configured for this option to use.

OptionConfiguration

data OptionConfiguration

A list of all available options

See: optionConfiguration smart constructor.

Instances

Eq OptionConfiguration

Data OptionConfiguration

Read OptionConfiguration

Show OptionConfiguration

Generic OptionConfiguration

ToQuery OptionConfiguration

Typeable * OptionConfiguration

type Rep OptionConfiguration

optionConfiguration

Arguments

:: Text

ocOptionName

-> OptionConfiguration

Creates a value of OptionConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ocOptionSettings
• ocVPCSecurityGroupMemberships
• ocDBSecurityGroupMemberships
• ocPort
• ocOptionName

ocOptionSettings :: Lens' OptionConfiguration [OptionSetting]

The option settings to include in an option group.

ocVPCSecurityGroupMemberships :: Lens' OptionConfiguration [Text]

A list of VpcSecurityGroupMemebrship name strings used for this option.

ocDBSecurityGroupMemberships :: Lens' OptionConfiguration [Text]

A list of DBSecurityGroupMemebrship name strings used for this option.

ocPort :: Lens' OptionConfiguration (Maybe Int)

The optional port for the option.

ocOptionName :: Lens' OptionConfiguration Text

The configuration of options to include in a group.

OptionGroup

data OptionGroup

See: optionGroup smart constructor.

Instances

Eq OptionGroup

Data OptionGroup

Read OptionGroup

Show OptionGroup

Generic OptionGroup

FromXML OptionGroup

Typeable * OptionGroup

type Rep OptionGroup

optionGroup :: OptionGroup

Creates a value of OptionGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ogOptionGroupDescription
• ogVPCId
• ogAllowsVPCAndNonVPCInstanceMemberships
• ogEngineName
• ogMajorEngineVersion
• ogOptions
• ogOptionGroupName

ogOptionGroupDescription :: Lens' OptionGroup (Maybe Text)

Provides a description of the option group.

ogVPCId :: Lens' OptionGroup (Maybe Text)

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

ogAllowsVPCAndNonVPCInstanceMemberships :: Lens' OptionGroup (Maybe Bool)

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

ogEngineName :: Lens' OptionGroup (Maybe Text)

Indicates the name of the engine that this option group can be applied to.

ogMajorEngineVersion :: Lens' OptionGroup (Maybe Text)

Indicates the major engine version associated with this option group.

ogOptions :: Lens' OptionGroup [Option]

Indicates what options are available in the option group.

ogOptionGroupName :: Lens' OptionGroup (Maybe Text)

Specifies the name of the option group.

OptionGroupMembership

data OptionGroupMembership

Provides information on the option groups the DB instance is a member of.

See: optionGroupMembership smart constructor.

Instances

Eq OptionGroupMembership

Data OptionGroupMembership

Read OptionGroupMembership

Show OptionGroupMembership

Generic OptionGroupMembership

FromXML OptionGroupMembership

Typeable * OptionGroupMembership

type Rep OptionGroupMembership

optionGroupMembership :: OptionGroupMembership

Creates a value of OptionGroupMembership with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ogmStatus
• ogmOptionGroupName

ogmStatus :: Lens' OptionGroupMembership (Maybe Text)

The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

ogmOptionGroupName :: Lens' OptionGroupMembership (Maybe Text)

The name of the option group that the instance belongs to.

OptionGroupOption

data OptionGroupOption

Available option.

See: optionGroupOption smart constructor.

Instances

Eq OptionGroupOption

Data OptionGroupOption

Read OptionGroupOption

Show OptionGroupOption

Generic OptionGroupOption

FromXML OptionGroupOption

Typeable * OptionGroupOption

type Rep OptionGroupOption

optionGroupOption :: OptionGroupOption

Creates a value of OptionGroupOption with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ogoMinimumRequiredMinorEngineVersion
• ogoPermanent
• ogoPersistent
• ogoEngineName
• ogoName
• ogoMajorEngineVersion
• ogoDefaultPort
• ogoOptionGroupOptionSettings
• ogoPortRequired
• ogoOptionsDependedOn
• ogoDescription

ogoMinimumRequiredMinorEngineVersion :: Lens' OptionGroupOption (Maybe Text)

The minimum required engine version for the option to be applied.

ogoPermanent :: Lens' OptionGroupOption (Maybe Bool)

A permanent option cannot be removed from the option group once the option group is used, and it cannot be removed from the db instance after assigning an option group with this permanent option.

ogoPersistent :: Lens' OptionGroupOption (Maybe Bool)

A persistent option cannot be removed from the option group once the option group is used, but this option can be removed from the db instance while modifying the related data and assigning another option group without this option.

ogoEngineName :: Lens' OptionGroupOption (Maybe Text)

The name of the engine that this option can be applied to.

ogoName :: Lens' OptionGroupOption (Maybe Text)

The name of the option.

ogoMajorEngineVersion :: Lens' OptionGroupOption (Maybe Text)

Indicates the major engine version that the option is available for.

ogoDefaultPort :: Lens' OptionGroupOption (Maybe Int)

If the option requires a port, specifies the default port for the option.

ogoOptionGroupOptionSettings :: Lens' OptionGroupOption [OptionGroupOptionSetting]

Specifies the option settings that are available (and the default value) for each option in an option group.

ogoPortRequired :: Lens' OptionGroupOption (Maybe Bool)

Specifies whether the option requires a port.

ogoOptionsDependedOn :: Lens' OptionGroupOption [Text]

List of all options that are prerequisites for this option.

ogoDescription :: Lens' OptionGroupOption (Maybe Text)

The description of the option.

OptionGroupOptionSetting

data OptionGroupOptionSetting

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

See: optionGroupOptionSetting smart constructor.

Instances

Eq OptionGroupOptionSetting

Data OptionGroupOptionSetting

Read OptionGroupOptionSetting

Show OptionGroupOptionSetting

Generic OptionGroupOptionSetting

FromXML OptionGroupOptionSetting

Typeable * OptionGroupOptionSetting

type Rep OptionGroupOptionSetting

optionGroupOptionSetting :: OptionGroupOptionSetting

Creates a value of OptionGroupOptionSetting with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ogosApplyType
• ogosSettingName
• ogosDefaultValue
• ogosIsModifiable
• ogosAllowedValues
• ogosSettingDescription

ogosApplyType :: Lens' OptionGroupOptionSetting (Maybe Text)

The DB engine specific parameter type for the option group option.

ogosSettingName :: Lens' OptionGroupOptionSetting (Maybe Text)

The name of the option group option.

ogosDefaultValue :: Lens' OptionGroupOptionSetting (Maybe Text)

The default value for the option group option.

ogosIsModifiable :: Lens' OptionGroupOptionSetting (Maybe Bool)

Boolean value where true indicates that this option group option can be changed from the default value.

ogosAllowedValues :: Lens' OptionGroupOptionSetting (Maybe Text)

Indicates the acceptable values for the option group option.

ogosSettingDescription :: Lens' OptionGroupOptionSetting (Maybe Text)

The description of the option group option.

OptionSetting

data OptionSetting

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

See: optionSetting smart constructor.

Instances

Eq OptionSetting

Data OptionSetting

Read OptionSetting

Show OptionSetting

Generic OptionSetting

FromXML OptionSetting

ToQuery OptionSetting

Typeable * OptionSetting

type Rep OptionSetting

optionSetting :: OptionSetting

Creates a value of OptionSetting with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• osIsCollection
• osApplyType
• osValue
• osName
• osDefaultValue
• osIsModifiable
• osAllowedValues
• osDataType
• osDescription

osIsCollection :: Lens' OptionSetting (Maybe Bool)

Indicates if the option setting is part of a collection.

osApplyType :: Lens' OptionSetting (Maybe Text)

The DB engine specific parameter type.

osValue :: Lens' OptionSetting (Maybe Text)

The current value of the option setting.

osName :: Lens' OptionSetting (Maybe Text)

The name of the option that has settings that you can set.

osDefaultValue :: Lens' OptionSetting (Maybe Text)

The default value of the option setting.

osIsModifiable :: Lens' OptionSetting (Maybe Bool)

A Boolean value that, when true, indicates the option setting can be modified from the default.

osAllowedValues :: Lens' OptionSetting (Maybe Text)

The allowed values of the option setting.

osDataType :: Lens' OptionSetting (Maybe Text)

The data type of the option setting.

osDescription :: Lens' OptionSetting (Maybe Text)

The description of the option setting.

OrderableDBInstanceOption

data OrderableDBInstanceOption

Contains a list of available options for a DB instance

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

See: orderableDBInstanceOption smart constructor.

Instances

Eq OrderableDBInstanceOption

Data OrderableDBInstanceOption

Read OrderableDBInstanceOption

Show OrderableDBInstanceOption

Generic OrderableDBInstanceOption

FromXML OrderableDBInstanceOption

Typeable * OrderableDBInstanceOption

type Rep OrderableDBInstanceOption

orderableDBInstanceOption :: OrderableDBInstanceOption

Creates a value of OrderableDBInstanceOption with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• odioEngineVersion
• odioMultiAZCapable
• odioEngine
• odioSupportsIOPS
• odioDBInstanceClass
• odioLicenseModel
• odioAvailabilityZones
• odioReadReplicaCapable
• odioSupportsStorageEncryption
• odioVPC
• odioStorageType

odioEngineVersion :: Lens' OrderableDBInstanceOption (Maybe Text)

The engine version of the orderable DB instance.

odioMultiAZCapable :: Lens' OrderableDBInstanceOption (Maybe Bool)

Indicates whether this orderable DB instance is multi-AZ capable.

odioEngine :: Lens' OrderableDBInstanceOption (Maybe Text)

The engine type of the orderable DB instance.

odioSupportsIOPS :: Lens' OrderableDBInstanceOption (Maybe Bool)

Indicates whether this orderable DB instance supports provisioned IOPS.

odioDBInstanceClass :: Lens' OrderableDBInstanceOption (Maybe Text)

The DB instance class for the orderable DB instance.

odioLicenseModel :: Lens' OrderableDBInstanceOption (Maybe Text)

The license model for the orderable DB instance.

odioAvailabilityZones :: Lens' OrderableDBInstanceOption [AvailabilityZone]

A list of Availability Zones for the orderable DB instance.

odioReadReplicaCapable :: Lens' OrderableDBInstanceOption (Maybe Bool)

Indicates whether this orderable DB instance can have a Read Replica.

odioSupportsStorageEncryption :: Lens' OrderableDBInstanceOption (Maybe Bool)

Indicates whether this orderable DB instance supports encrypted storage.

odioVPC :: Lens' OrderableDBInstanceOption (Maybe Bool)

Indicates whether this is a VPC orderable DB instance.

odioStorageType :: Lens' OrderableDBInstanceOption (Maybe Text)

Indicates the storage type for this orderable DB instance.

Parameter

data Parameter

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

See: parameter smart constructor.

Instances

Eq Parameter

Data Parameter

Read Parameter

Show Parameter

Generic Parameter

FromXML Parameter

ToQuery Parameter

Typeable * Parameter

type Rep Parameter

parameter :: Parameter

Creates a value of Parameter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pApplyType
• pParameterValue
• pApplyMethod
• pMinimumEngineVersion
• pSource
• pIsModifiable
• pAllowedValues
• pDataType
• pParameterName
• pDescription

pApplyType :: Lens' Parameter (Maybe Text)

Specifies the engine specific parameters type.

pParameterValue :: Lens' Parameter (Maybe Text)

Specifies the value of the parameter.

pApplyMethod :: Lens' Parameter (Maybe ApplyMethod)

Indicates when to apply parameter updates.

pMinimumEngineVersion :: Lens' Parameter (Maybe Text)

The earliest engine version to which the parameter can apply.

pSource :: Lens' Parameter (Maybe Text)

Indicates the source of the parameter value.

pIsModifiable :: Lens' Parameter (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.

pAllowedValues :: Lens' Parameter (Maybe Text)

Specifies the valid range of values for the parameter.

pDataType :: Lens' Parameter (Maybe Text)

Specifies the valid data type for the parameter.

pParameterName :: Lens' Parameter (Maybe Text)

Specifies the name of the parameter.

pDescription :: Lens' Parameter (Maybe Text)

Provides a description of the parameter.

PendingMaintenanceAction

data PendingMaintenanceAction

Provides information about a pending maintenance action for a resource.

See: pendingMaintenanceAction smart constructor.

Instances

Eq PendingMaintenanceAction

Data PendingMaintenanceAction

Read PendingMaintenanceAction

Show PendingMaintenanceAction

Generic PendingMaintenanceAction

FromXML PendingMaintenanceAction

Typeable * PendingMaintenanceAction

type Rep PendingMaintenanceAction

pendingMaintenanceAction :: PendingMaintenanceAction

Creates a value of PendingMaintenanceAction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pmaAutoAppliedAfterDate
• pmaAction
• pmaOptInStatus
• pmaDescription
• pmaCurrentApplyDate
• pmaForcedApplyDate

pmaAutoAppliedAfterDate :: Lens' PendingMaintenanceAction (Maybe UTCTime)

The date of the maintenance window when the action will be applied. The maintenance action will be 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.

pmaAction :: Lens' PendingMaintenanceAction (Maybe Text)

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

pmaOptInStatus :: Lens' PendingMaintenanceAction (Maybe Text)

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

pmaDescription :: Lens' PendingMaintenanceAction (Maybe Text)

A description providing more detail about the maintenance action.

pmaCurrentApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime)

The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

pmaForcedApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime)

The date when the maintenance action will be automatically applied. The maintenance action will be 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.

PendingModifiedValues

data PendingModifiedValues

This data type is used as a response element in the ModifyDBInstance action.

See: pendingModifiedValues smart constructor.

Instances

Eq PendingModifiedValues

Data PendingModifiedValues

Read PendingModifiedValues

Show PendingModifiedValues

Generic PendingModifiedValues

FromXML PendingModifiedValues

Typeable * PendingModifiedValues

type Rep PendingModifiedValues

pendingModifiedValues :: PendingModifiedValues

Creates a value of PendingModifiedValues with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pmvEngineVersion
• pmvMasterUserPassword
• pmvIOPS
• pmvDBInstanceClass
• pmvDBInstanceIdentifier
• pmvCACertificateIdentifier
• pmvBackupRetentionPeriod
• pmvMultiAZ
• pmvAllocatedStorage
• pmvPort
• pmvStorageType

pmvEngineVersion :: Lens' PendingModifiedValues (Maybe Text)

Indicates the database engine version.

pmvMasterUserPassword :: Lens' PendingModifiedValues (Maybe Text)

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

pmvIOPS :: Lens' PendingModifiedValues (Maybe Int)

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

pmvDBInstanceClass :: Lens' PendingModifiedValues (Maybe Text)

Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

pmvDBInstanceIdentifier :: Lens' PendingModifiedValues (Maybe Text)

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

pmvCACertificateIdentifier :: Lens' PendingModifiedValues (Maybe Text)

Specifies the identifier of the CA certificate for the DB instance.

pmvBackupRetentionPeriod :: Lens' PendingModifiedValues (Maybe Int)

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

pmvMultiAZ :: Lens' PendingModifiedValues (Maybe Bool)

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

pmvAllocatedStorage :: Lens' PendingModifiedValues (Maybe Int)

Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

pmvPort :: Lens' PendingModifiedValues (Maybe Int)

Specifies the pending port for the DB instance.

pmvStorageType :: Lens' PendingModifiedValues (Maybe Text)

Specifies the storage type to be associated with the DB instance.

RecurringCharge

data RecurringCharge

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

See: recurringCharge smart constructor.

Instances

Eq RecurringCharge

Data RecurringCharge

Read RecurringCharge

Show RecurringCharge

Generic RecurringCharge

FromXML RecurringCharge

Typeable * RecurringCharge

type Rep RecurringCharge

recurringCharge :: RecurringCharge

Creates a value of RecurringCharge with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rcRecurringChargeFrequency
• rcRecurringChargeAmount

rcRecurringChargeFrequency :: Lens' RecurringCharge (Maybe Text)

The frequency of the recurring charge.

rcRecurringChargeAmount :: Lens' RecurringCharge (Maybe Double)

The amount of the recurring charge.

ReservedDBInstance

data ReservedDBInstance

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

See: reservedDBInstance smart constructor.

Instances

Eq ReservedDBInstance

Data ReservedDBInstance

Read ReservedDBInstance

Show ReservedDBInstance

Generic ReservedDBInstance

FromXML ReservedDBInstance

Typeable * ReservedDBInstance

type Rep ReservedDBInstance

reservedDBInstance :: ReservedDBInstance

Creates a value of ReservedDBInstance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdiDBInstanceCount
• rdiState
• rdiCurrencyCode
• rdiProductDescription
• rdiStartTime
• rdiReservedDBInstanceId
• rdiDBInstanceClass
• rdiMultiAZ
• rdiReservedDBInstancesOfferingId
• rdiOfferingType
• rdiUsagePrice
• rdiRecurringCharges
• rdiFixedPrice
• rdiDuration

rdiDBInstanceCount :: Lens' ReservedDBInstance (Maybe Int)

The number of reserved DB instances.

rdiState :: Lens' ReservedDBInstance (Maybe Text)

The state of the reserved DB instance.

rdiCurrencyCode :: Lens' ReservedDBInstance (Maybe Text)

The currency code for the reserved DB instance.

rdiProductDescription :: Lens' ReservedDBInstance (Maybe Text)

The description of the reserved DB instance.

rdiStartTime :: Lens' ReservedDBInstance (Maybe UTCTime)

The time the reservation started.

rdiReservedDBInstanceId :: Lens' ReservedDBInstance (Maybe Text)

The unique identifier for the reservation.

rdiDBInstanceClass :: Lens' ReservedDBInstance (Maybe Text)

The DB instance class for the reserved DB instance.

rdiMultiAZ :: Lens' ReservedDBInstance (Maybe Bool)

Indicates if the reservation applies to Multi-AZ deployments.

rdiReservedDBInstancesOfferingId :: Lens' ReservedDBInstance (Maybe Text)

The offering identifier.

rdiOfferingType :: Lens' ReservedDBInstance (Maybe Text)

The offering type of this reserved DB instance.

rdiUsagePrice :: Lens' ReservedDBInstance (Maybe Double)

The hourly price charged for this reserved DB instance.

rdiRecurringCharges :: Lens' ReservedDBInstance [RecurringCharge]

The recurring price charged to run this reserved DB instance.

rdiFixedPrice :: Lens' ReservedDBInstance (Maybe Double)

The fixed price charged for this reserved DB instance.

rdiDuration :: Lens' ReservedDBInstance (Maybe Int)

The duration of the reservation in seconds.

ReservedDBInstancesOffering

data ReservedDBInstancesOffering

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

See: reservedDBInstancesOffering smart constructor.

Instances

Eq ReservedDBInstancesOffering

Data ReservedDBInstancesOffering

Read ReservedDBInstancesOffering

Show ReservedDBInstancesOffering

Generic ReservedDBInstancesOffering

FromXML ReservedDBInstancesOffering

Typeable * ReservedDBInstancesOffering

type Rep ReservedDBInstancesOffering

reservedDBInstancesOffering :: ReservedDBInstancesOffering

Creates a value of ReservedDBInstancesOffering with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rdioCurrencyCode
• rdioProductDescription
• rdioDBInstanceClass
• rdioMultiAZ
• rdioReservedDBInstancesOfferingId
• rdioOfferingType
• rdioUsagePrice
• rdioRecurringCharges
• rdioFixedPrice
• rdioDuration

rdioCurrencyCode :: Lens' ReservedDBInstancesOffering (Maybe Text)

The currency code for the reserved DB instance offering.

rdioProductDescription :: Lens' ReservedDBInstancesOffering (Maybe Text)

The database engine used by the offering.

rdioDBInstanceClass :: Lens' ReservedDBInstancesOffering (Maybe Text)

The DB instance class for the reserved DB instance.

rdioMultiAZ :: Lens' ReservedDBInstancesOffering (Maybe Bool)

Indicates if the offering applies to Multi-AZ deployments.

rdioReservedDBInstancesOfferingId :: Lens' ReservedDBInstancesOffering (Maybe Text)

The offering identifier.

rdioOfferingType :: Lens' ReservedDBInstancesOffering (Maybe Text)

The offering type.

rdioUsagePrice :: Lens' ReservedDBInstancesOffering (Maybe Double)

The hourly price charged for this offering.

rdioRecurringCharges :: Lens' ReservedDBInstancesOffering [RecurringCharge]

The recurring price charged to run this reserved DB instance.

rdioFixedPrice :: Lens' ReservedDBInstancesOffering (Maybe Double)

The fixed price charged for this offering.

rdioDuration :: Lens' ReservedDBInstancesOffering (Maybe Int)

The duration of the offering in seconds.

ResourcePendingMaintenanceActions

data ResourcePendingMaintenanceActions

Describes the pending maintenance actions for a resource.

See: resourcePendingMaintenanceActions smart constructor.

Instances

Eq ResourcePendingMaintenanceActions

Data ResourcePendingMaintenanceActions

Read ResourcePendingMaintenanceActions

Show ResourcePendingMaintenanceActions

Generic ResourcePendingMaintenanceActions

FromXML ResourcePendingMaintenanceActions

Typeable * ResourcePendingMaintenanceActions

type Rep ResourcePendingMaintenanceActions

resourcePendingMaintenanceActions :: ResourcePendingMaintenanceActions

Creates a value of ResourcePendingMaintenanceActions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rpmaPendingMaintenanceActionDetails
• rpmaResourceIdentifier

rpmaPendingMaintenanceActionDetails :: Lens' ResourcePendingMaintenanceActions [PendingMaintenanceAction]

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

rpmaResourceIdentifier :: Lens' ResourcePendingMaintenanceActions (Maybe Text)

The ARN of the resource that has pending maintenance actions.

Subnet

data Subnet

This data type is used as a response element in the DescribeDBSubnetGroups action.

See: subnet smart constructor.

Instances

Eq Subnet

Data Subnet

Read Subnet

Show Subnet

Generic Subnet

FromXML Subnet

Typeable * Subnet

type Rep Subnet

subnet :: Subnet

Creates a value of Subnet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sSubnetStatus
• sSubnetIdentifier
• sSubnetAvailabilityZone

sSubnetStatus :: Lens' Subnet (Maybe Text)

Specifies the status of the subnet.

sSubnetIdentifier :: Lens' Subnet (Maybe Text)

Specifies the identifier of the subnet.

sSubnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone)

Undocumented member.

Tag

data Tag

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

See: tag smart constructor.

Instances

Eq Tag

Data Tag

Read Tag

Show Tag

Generic Tag

FromXML Tag

ToQuery Tag

Typeable * Tag

type Rep Tag

tag :: Tag

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tagValue
• tagKey

tagValue :: Lens' Tag (Maybe Text)

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

tagKey :: Lens' Tag (Maybe Text)

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

VPCSecurityGroupMembership

data VPCSecurityGroupMembership

This data type is used as a response element for queries on VPC security group membership.

See: vpcSecurityGroupMembership smart constructor.

Instances

Eq VPCSecurityGroupMembership

Data VPCSecurityGroupMembership

Read VPCSecurityGroupMembership

Show VPCSecurityGroupMembership

Generic VPCSecurityGroupMembership

FromXML VPCSecurityGroupMembership

Typeable * VPCSecurityGroupMembership

type Rep VPCSecurityGroupMembership

vpcSecurityGroupMembership :: VPCSecurityGroupMembership

Creates a value of VPCSecurityGroupMembership with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• vsgmStatus
• vsgmVPCSecurityGroupId

vsgmStatus :: Lens' VPCSecurityGroupMembership (Maybe Text)

The status of the VPC security group.

vsgmVPCSecurityGroupId :: Lens' VPCSecurityGroupMembership (Maybe Text)

The name of the VPC security group.