amazonka-rds-0.1.2: Amazon Relational Database Service SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.RDS.Types

Contents

Synopsis

Service

data RDS Source

Version 2014-09-01 of the Amazon Relational Database Service service.

Instances

AWSService RDS 
type Er RDS = RESTError 
type Sg RDS = V4 

Error

data RESTError :: *

Instances

Eq RESTError 
Show RESTError 
Generic RESTError 
AWSErrorCode RESTError 
FromXML RESTError 
type Rep RESTError = D1 D1RESTError (C1 C1_0RESTError ((:*:) ((:*:) (S1 S1_0_0RESTError (Rec0 Text)) (S1 S1_0_1RESTError (Rec0 (Maybe ErrorType)))) ((:*:) (S1 S1_0_2RESTError (Rec0 ErrorCode)) (S1 S1_0_3RESTError (Rec0 Text))))) 

XML

OptionGroup

ogAllowsVpcAndNonVpcInstanceMemberships :: Lens' OptionGroup (Maybe Bool) Source

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) Source

Engine name that this option group can be applied to.

ogMajorEngineVersion :: Lens' OptionGroup (Maybe Text) Source

Indicates the major engine version associated with this option group.

ogOptionGroupDescription :: Lens' OptionGroup (Maybe Text) Source

Provides the description of the option group.

ogOptionGroupName :: Lens' OptionGroup (Maybe Text) Source

Specifies the name of the option group.

ogOptions :: Lens' OptionGroup [Option] Source

Indicates what options are available in the option group.

ogVpcId :: Lens' OptionGroup (Maybe Text) Source

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.

DBParameterGroupStatus

dbpgsDBParameterGroupName :: Lens' DBParameterGroupStatus (Maybe Text) Source

The name of the DP parameter group.

Event

event :: Event Source

Event constructor.

The fields accessible through corresponding lenses are:

eDate :: Lens' Event (Maybe UTCTime) Source

Specifies the date and time of the event.

eEventCategories :: Lens' Event [Text] Source

Specifies the category for the event.

eMessage :: Lens' Event (Maybe Text) Source

Provides the text of this event.

eSourceIdentifier :: Lens' Event (Maybe Text) Source

Provides the identifier for the source of the event.

eSourceType :: Lens' Event (Maybe SourceType) Source

Specifies the source type for this event.

DBSecurityGroup

dbsgDBSecurityGroupDescription :: Lens' DBSecurityGroup (Maybe Text) Source

Provides the description of the DB security group.

dbsgDBSecurityGroupName :: Lens' DBSecurityGroup (Maybe Text) Source

Specifies the name of the DB security group.

dbsgIPRanges :: Lens' DBSecurityGroup [IPRange] Source

Contains a list of IPRange elements.

dbsgOwnerId :: Lens' DBSecurityGroup (Maybe Text) Source

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

dbsgVpcId :: Lens' DBSecurityGroup (Maybe Text) Source

Provides the VpcId of the DB security group.

Tag

tag :: Tag Source

Tag constructor.

The fields accessible through corresponding lenses are:

tagKey :: Lens' Tag (Maybe Text) Source

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 may only contain only the set of Unicode letters, digits, white-space, '_', ., /, '=', +, - (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

tagValue :: Lens' Tag (Maybe Text) Source

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 may only contain only the set of Unicode letters, digits, white-space, '_', ., /, '=', +, - (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

DBEngineVersion

dbevDBEngineDescription :: Lens' DBEngineVersion (Maybe Text) Source

The description of the database engine.

dbevDBEngineVersionDescription :: Lens' DBEngineVersion (Maybe Text) Source

The description of the database engine version.

dbevDBParameterGroupFamily :: Lens' DBEngineVersion (Maybe Text) Source

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

dbevDefaultCharacterSet :: Lens' DBEngineVersion (Maybe CharacterSet) Source

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

dbevEngine :: Lens' DBEngineVersion (Maybe Text) Source

The name of the database engine.

dbevEngineVersion :: Lens' DBEngineVersion (Maybe Text) Source

The version number of the database engine.

dbevSupportedCharacterSets :: Lens' DBEngineVersion [CharacterSet] Source

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

DBSnapshot

dbsAllocatedStorage :: Lens' DBSnapshot (Maybe Int) Source

Specifies the allocated storage size in gigabytes (GB).

dbsAvailabilityZone :: Lens' DBSnapshot (Maybe Text) Source

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

dbsDBInstanceIdentifier :: Lens' DBSnapshot (Maybe Text) Source

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

dbsDBSnapshotIdentifier :: Lens' DBSnapshot (Maybe Text) Source

Specifies the identifier for the DB snapshot.

dbsEngine :: Lens' DBSnapshot (Maybe Text) Source

Specifies the name of the database engine.

dbsEngineVersion :: Lens' DBSnapshot (Maybe Text) Source

Specifies the version of the database engine.

dbsInstanceCreateTime :: Lens' DBSnapshot (Maybe UTCTime) Source

Specifies the time (UTC) when the snapshot was taken.

dbsIops :: Lens' DBSnapshot (Maybe Int) Source

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

dbsLicenseModel :: Lens' DBSnapshot (Maybe Text) Source

License model information for the restored DB instance.

dbsMasterUsername :: Lens' DBSnapshot (Maybe Text) Source

Provides the master username for the DB snapshot.

dbsOptionGroupName :: Lens' DBSnapshot (Maybe Text) Source

Provides the option group name for the DB snapshot.

dbsPercentProgress :: Lens' DBSnapshot (Maybe Int) Source

The percentage of the estimated data that has been transferred.

dbsPort :: Lens' DBSnapshot (Maybe Int) Source

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

dbsSnapshotCreateTime :: Lens' DBSnapshot (Maybe UTCTime) Source

Provides the time (UTC) when the snapshot was taken.

dbsSnapshotType :: Lens' DBSnapshot (Maybe Text) Source

Provides the type of the DB snapshot.

dbsSourceRegion :: Lens' DBSnapshot (Maybe Text) Source

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

dbsStatus :: Lens' DBSnapshot (Maybe Text) Source

Specifies the status of this DB snapshot.

dbsStorageType :: Lens' DBSnapshot (Maybe Text) Source

Specifies storage type associated with DB Snapshot.

dbsTdeCredentialArn :: Lens' DBSnapshot (Maybe Text) Source

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

dbsVpcId :: Lens' DBSnapshot (Maybe Text) Source

Provides the Vpc Id associated with the DB snapshot.

DBSecurityGroupMembership

dbsgmStatus :: Lens' DBSecurityGroupMembership (Maybe Text) Source

The status of the DB security group.

EC2SecurityGroup

ecsgEC2SecurityGroupId :: Lens' EC2SecurityGroup (Maybe Text) Source

Specifies the id of the EC2 security group.

ecsgEC2SecurityGroupName :: Lens' EC2SecurityGroup (Maybe Text) Source

Specifies the name of the EC2 security group.

ecsgEC2SecurityGroupOwnerId :: Lens' EC2SecurityGroup (Maybe Text) Source

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

ecsgStatus :: Lens' EC2SecurityGroup (Maybe Text) Source

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

SourceType

DBParameterGroup

dbpgDBParameterGroupFamily :: Lens' DBParameterGroup (Maybe Text) Source

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

dbpgDBParameterGroupName :: Lens' DBParameterGroup (Maybe Text) Source

Provides the name of the DB parameter group.

dbpgDescription :: Lens' DBParameterGroup (Maybe Text) Source

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

ReservedDBInstancesOffering

rdbioCurrencyCode :: Lens' ReservedDBInstancesOffering (Maybe Text) Source

The currency code for the reserved DB instance offering.

rdbioDBInstanceClass :: Lens' ReservedDBInstancesOffering (Maybe Text) Source

The DB instance class for the reserved DB instance.

rdbioDuration :: Lens' ReservedDBInstancesOffering (Maybe Int) Source

The duration of the offering in seconds.

rdbioFixedPrice :: Lens' ReservedDBInstancesOffering (Maybe Double) Source

The fixed price charged for this offering.

rdbioMultiAZ :: Lens' ReservedDBInstancesOffering (Maybe Bool) Source

Indicates if the offering applies to Multi-AZ deployments.

rdbioProductDescription :: Lens' ReservedDBInstancesOffering (Maybe Text) Source

The database engine used by the offering.

rdbioRecurringCharges :: Lens' ReservedDBInstancesOffering [RecurringCharge] Source

The recurring price charged to run this reserved DB instance.

rdbioUsagePrice :: Lens' ReservedDBInstancesOffering (Maybe Double) Source

The hourly price charged for this offering.

ApplyMethod

CharacterSet

characterSet :: CharacterSet Source

CharacterSet constructor.

The fields accessible through corresponding lenses are:

csCharacterSetDescription :: Lens' CharacterSet (Maybe Text) Source

The description of the character set.

csCharacterSetName :: Lens' CharacterSet (Maybe Text) Source

The name of the character set.

Subnet

subnet :: Subnet Source

Subnet constructor.

The fields accessible through corresponding lenses are:

sSubnetIdentifier :: Lens' Subnet (Maybe Text) Source

Specifies the identifier of the subnet.

sSubnetStatus :: Lens' Subnet (Maybe Text) Source

Specifies the status of the subnet.

ReservedDBInstance

rdbiCurrencyCode :: Lens' ReservedDBInstance (Maybe Text) Source

The currency code for the reserved DB instance.

rdbiDBInstanceClass :: Lens' ReservedDBInstance (Maybe Text) Source

The DB instance class for the reserved DB instance.

rdbiDBInstanceCount :: Lens' ReservedDBInstance (Maybe Int) Source

The number of reserved DB instances.

rdbiDuration :: Lens' ReservedDBInstance (Maybe Int) Source

The duration of the reservation in seconds.

rdbiFixedPrice :: Lens' ReservedDBInstance (Maybe Double) Source

The fixed price charged for this reserved DB instance.

rdbiMultiAZ :: Lens' ReservedDBInstance (Maybe Bool) Source

Indicates if the reservation applies to Multi-AZ deployments.

rdbiOfferingType :: Lens' ReservedDBInstance (Maybe Text) Source

The offering type of this reserved DB instance.

rdbiProductDescription :: Lens' ReservedDBInstance (Maybe Text) Source

The description of the reserved DB instance.

rdbiRecurringCharges :: Lens' ReservedDBInstance [RecurringCharge] Source

The recurring price charged to run this reserved DB instance.

rdbiReservedDBInstanceId :: Lens' ReservedDBInstance (Maybe Text) Source

The unique identifier for the reservation.

rdbiStartTime :: Lens' ReservedDBInstance (Maybe UTCTime) Source

The time the reservation started.

rdbiState :: Lens' ReservedDBInstance (Maybe Text) Source

The state of the reserved DB instance.

rdbiUsagePrice :: Lens' ReservedDBInstance (Maybe Double) Source

The hourly price charged for this reserved DB instance.

EngineDefaults

engineDefaults :: EngineDefaults Source

EngineDefaults constructor.

The fields accessible through corresponding lenses are:

edDBParameterGroupFamily :: Lens' EngineDefaults (Maybe Text) Source

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

edMarker :: Lens' EngineDefaults (Maybe Text) Source

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 .

edParameters :: Lens' EngineDefaults [Parameter] Source

Contains a list of engine default parameters.

DBParameterGroupNameMessage

OptionGroupOption

ogoDefaultPort :: Lens' OptionGroupOption (Maybe Int) Source

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

ogoDescription :: Lens' OptionGroupOption (Maybe Text) Source

The description of the option.

ogoEngineName :: Lens' OptionGroupOption (Maybe Text) Source

Engine name that this option can be applied to.

ogoMajorEngineVersion :: Lens' OptionGroupOption (Maybe Text) Source

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

ogoMinimumRequiredMinorEngineVersion :: Lens' OptionGroupOption (Maybe Text) Source

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

ogoName :: Lens' OptionGroupOption (Maybe Text) Source

The name of the option.

ogoOptionGroupOptionSettings :: Lens' OptionGroupOption [OptionGroupOptionSetting] Source

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

ogoOptionsDependedOn :: Lens' OptionGroupOption [Text] Source

List of all options that are prerequisites for this option.

ogoPermanent :: Lens' OptionGroupOption (Maybe Bool) Source

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) Source

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.

ogoPortRequired :: Lens' OptionGroupOption (Maybe Bool) Source

Specifies whether the option requires a port.

DBInstance

dbiAllocatedStorage :: Lens' DBInstance (Maybe Int) Source

Specifies the allocated storage size specified in gigabytes.

dbiAutoMinorVersionUpgrade :: Lens' DBInstance (Maybe Bool) Source

Indicates that minor version patches are applied automatically.

dbiAvailabilityZone :: Lens' DBInstance (Maybe Text) Source

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

dbiBackupRetentionPeriod :: Lens' DBInstance (Maybe Int) Source

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

dbiCharacterSetName :: Lens' DBInstance (Maybe Text) Source

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

dbiDBInstanceClass :: Lens' DBInstance (Maybe Text) Source

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

dbiDBInstanceIdentifier :: Lens' DBInstance (Maybe Text) Source

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

dbiDBInstanceStatus :: Lens' DBInstance (Maybe Text) Source

Specifies the current state of this database.

dbiDBName :: Lens' DBInstance (Maybe Text) Source

The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL.

MySQL

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.

dbiDBParameterGroups :: Lens' DBInstance [DBParameterGroupStatus] Source

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

dbiDBSecurityGroups :: Lens' DBInstance [DBSecurityGroupMembership] Source

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

dbiDBSubnetGroup :: Lens' DBInstance (Maybe DBSubnetGroup) Source

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

dbiEndpoint :: Lens' DBInstance (Maybe Endpoint) Source

Specifies the connection endpoint.

dbiEngine :: Lens' DBInstance (Maybe Text) Source

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

dbiEngineVersion :: Lens' DBInstance (Maybe Text) Source

Indicates the database engine version.

dbiInstanceCreateTime :: Lens' DBInstance (Maybe UTCTime) Source

Provides the date and time the DB instance was created.

dbiIops :: Lens' DBInstance (Maybe Int) Source

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

dbiLatestRestorableTime :: Lens' DBInstance (Maybe UTCTime) Source

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

dbiLicenseModel :: Lens' DBInstance (Maybe Text) Source

License model information for this DB instance.

dbiMasterUsername :: Lens' DBInstance (Maybe Text) Source

Contains the master username for the DB instance.

dbiMultiAZ :: Lens' DBInstance (Maybe Bool) Source

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

dbiOptionGroupMemberships :: Lens' DBInstance [OptionGroupMembership] Source

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

dbiPendingModifiedValues :: Lens' DBInstance (Maybe PendingModifiedValues) Source

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

dbiPreferredBackupWindow :: 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.

dbiPreferredMaintenanceWindow :: Lens' DBInstance (Maybe Text) Source

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

dbiPubliclyAccessible :: Lens' DBInstance (Maybe Bool) Source

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.

dbiReadReplicaDBInstanceIdentifiers :: Lens' DBInstance [Text] Source

Contains one or more identifiers of the read replicas associated with this DB instance.

dbiReadReplicaSourceDBInstanceIdentifier :: Lens' DBInstance (Maybe Text) Source

Contains the identifier of the source DB instance if this DB instance is a read replica.

dbiSecondaryAvailabilityZone :: Lens' DBInstance (Maybe Text) Source

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

dbiStatusInfos :: Lens' DBInstance [DBInstanceStatusInfo] Source

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

dbiStorageType :: Lens' DBInstance (Maybe Text) Source

Specifies storage type associated with DB Instance.

dbiTdeCredentialArn :: Lens' DBInstance (Maybe Text) Source

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

dbiVpcSecurityGroups :: Lens' DBInstance [VpcSecurityGroupMembership] Source

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

AvailabilityZone

availabilityZone :: AvailabilityZone Source

AvailabilityZone constructor.

The fields accessible through corresponding lenses are:

azName :: Lens' AvailabilityZone (Maybe Text) Source

The name of the availability zone.

EventSubscription

esCustSubscriptionId :: Lens' EventSubscription (Maybe Text) Source

The RDS event notification subscription Id.

esCustomerAwsId :: Lens' EventSubscription (Maybe Text) Source

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

esEnabled :: Lens' EventSubscription (Maybe Bool) Source

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

esEventCategoriesList :: Lens' EventSubscription [Text] Source

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

esSnsTopicArn :: Lens' EventSubscription (Maybe Text) Source

The topic ARN of the RDS event notification subscription.

esSourceIdsList :: Lens' EventSubscription [Text] Source

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

esSourceType :: Lens' EventSubscription (Maybe Text) Source

The source type for the RDS event notification subscription.

esStatus :: Lens' EventSubscription (Maybe Text) Source

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.

esSubscriptionCreationTime :: Lens' EventSubscription (Maybe Text) Source

The time the RDS event notification subscription was created.

DBSubnetGroup

dbsg1DBSubnetGroupDescription :: Lens' DBSubnetGroup (Maybe Text) Source

Provides the description of the DB subnet group.

dbsg1DBSubnetGroupName :: Lens' DBSubnetGroup (Maybe Text) Source

Specifies the name of the DB subnet group.

dbsg1SubnetGroupStatus :: Lens' DBSubnetGroup (Maybe Text) Source

Provides the status of the DB subnet group.

dbsg1Subnets :: Lens' DBSubnetGroup [Subnet] Source

Contains a list of Subnet elements.

dbsg1VpcId :: Lens' DBSubnetGroup (Maybe Text) Source

Provides the VpcId of the DB subnet group.

DBInstanceStatusInfo

dbisiMessage :: 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.

dbisiNormal :: Lens' DBInstanceStatusInfo (Maybe Bool) Source

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

dbisiStatus :: Lens' DBInstanceStatusInfo (Maybe Text) Source

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

dbisiStatusType :: Lens' DBInstanceStatusInfo (Maybe Text) Source

This value is currently "read replication."

OptionSetting

osAllowedValues :: Lens' OptionSetting (Maybe Text) Source

The allowed values of the option setting.

osApplyType :: Lens' OptionSetting (Maybe Text) Source

The DB engine specific parameter type.

osDataType :: Lens' OptionSetting (Maybe Text) Source

The data type of the option setting.

osDefaultValue :: Lens' OptionSetting (Maybe Text) Source

The default value of the option setting.

osDescription :: Lens' OptionSetting (Maybe Text) Source

The description of the option setting.

osIsCollection :: Lens' OptionSetting (Maybe Bool) Source

Indicates if the option setting is part of a collection.

osIsModifiable :: Lens' OptionSetting (Maybe Bool) Source

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

osName :: Lens' OptionSetting (Maybe Text) Source

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

osValue :: Lens' OptionSetting (Maybe Text) Source

The current value of the option setting.

DescribeDBLogFilesDetails

ddblfdLastWritten :: Lens' DescribeDBLogFilesDetails (Maybe Integer) Source

A POSIX timestamp when the last log entry was written.

ddblfdLogFileName :: Lens' DescribeDBLogFilesDetails (Maybe Text) Source

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

ddblfdSize :: Lens' DescribeDBLogFilesDetails (Maybe Integer) Source

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

OrderableDBInstanceOption

odbioAvailabilityZones :: Lens' OrderableDBInstanceOption [AvailabilityZone] Source

A list of availability zones for the orderable DB instance.

odbioDBInstanceClass :: Lens' OrderableDBInstanceOption (Maybe Text) Source

The DB instance Class for the orderable DB instance

odbioEngine :: Lens' OrderableDBInstanceOption (Maybe Text) Source

The engine type of the orderable DB instance.

odbioEngineVersion :: Lens' OrderableDBInstanceOption (Maybe Text) Source

The engine version of the orderable DB instance.

odbioLicenseModel :: Lens' OrderableDBInstanceOption (Maybe Text) Source

The license model for the orderable DB instance.

odbioMultiAZCapable :: Lens' OrderableDBInstanceOption (Maybe Bool) Source

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

odbioReadReplicaCapable :: Lens' OrderableDBInstanceOption (Maybe Bool) Source

Indicates whether this orderable DB instance can have a read replica.

odbioStorageType :: Lens' OrderableDBInstanceOption (Maybe Text) Source

The storage type for this orderable DB instance.

odbioSupportsIops :: Lens' OrderableDBInstanceOption (Maybe Bool) Source

Indicates whether this orderable DB instance supports provisioned IOPS.

odbioVpc :: Lens' OrderableDBInstanceOption (Maybe Bool) Source

Indicates whether this is a VPC orderable DB instance.

Filter

filter' Source

Arguments

:: Text

fName

-> Filter 

Filter constructor.

The fields accessible through corresponding lenses are:

fName :: Lens' Filter Text Source

This parameter is not currently supported.

fValues :: Lens' Filter [Text] Source

This parameter is not currently supported.

RecurringCharge

recurringCharge :: RecurringCharge Source

RecurringCharge constructor.

The fields accessible through corresponding lenses are:

rcRecurringChargeAmount :: Lens' RecurringCharge (Maybe Double) Source

The amount of the recurring charge.

rcRecurringChargeFrequency :: Lens' RecurringCharge (Maybe Text) Source

The frequency of the recurring charge.

Endpoint

endpoint :: Endpoint Source

Endpoint constructor.

The fields accessible through corresponding lenses are:

eAddress :: Lens' Endpoint (Maybe Text) Source

Specifies the DNS address of the DB instance.

ePort :: Lens' Endpoint (Maybe Int) Source

Specifies the port that the database engine is listening on.

OptionConfiguration

ocDBSecurityGroupMemberships :: Lens' OptionConfiguration [Text] Source

A list of DBSecurityGroupMemebrship name strings used for this option.

ocOptionName :: Lens' OptionConfiguration Text Source

The configuration of options to include in a group.

ocOptionSettings :: Lens' OptionConfiguration [OptionSetting] Source

The option settings to include in an option group.

ocPort :: Lens' OptionConfiguration (Maybe Int) Source

The optional port for the option.

ocVpcSecurityGroupMemberships :: Lens' OptionConfiguration [Text] Source

A list of VpcSecurityGroupMemebrship name strings used for this option.

Option

oDBSecurityGroupMemberships :: Lens' Option [DBSecurityGroupMembership] Source

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

oOptionDescription :: Lens' Option (Maybe Text) Source

The description of the option.

oOptionName :: Lens' Option (Maybe Text) Source

The name of the option.

oOptionSettings :: Lens' Option [OptionSetting] Source

The option settings for this option.

oPermanent :: Lens' Option (Maybe Bool) Source

Indicate if this option is permanent.

oPersistent :: Lens' Option (Maybe Bool) Source

Indicate if this option is persistent.

oPort :: Lens' Option (Maybe Int) Source

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

oVpcSecurityGroupMemberships :: Lens' Option [VpcSecurityGroupMembership] Source

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

IPRange

iprange :: IPRange Source

IPRange constructor.

The fields accessible through corresponding lenses are:

iprCIDRIP :: Lens' IPRange (Maybe Text) Source

Specifies the IP range.

iprStatus :: Lens' IPRange (Maybe Text) Source

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

OptionGroupMembership

optionGroupMembership :: OptionGroupMembership Source

OptionGroupMembership constructor.

The fields accessible through corresponding lenses are:

ogmOptionGroupName :: Lens' OptionGroupMembership (Maybe Text) Source

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

ogmStatus :: Lens' OptionGroupMembership (Maybe Text) Source

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

EventCategoriesMap

eventCategoriesMap :: EventCategoriesMap Source

EventCategoriesMap constructor.

The fields accessible through corresponding lenses are:

ecmEventCategories :: Lens' EventCategoriesMap [Text] Source

The event categories for the specified source type

ecmSourceType :: Lens' EventCategoriesMap (Maybe Text) Source

The source type that the returned categories belong to

PendingModifiedValues

pmvAllocatedStorage :: Lens' PendingModifiedValues (Maybe Int) Source

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

pmvBackupRetentionPeriod :: Lens' PendingModifiedValues (Maybe Int) Source

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

pmvDBInstanceClass :: Lens' PendingModifiedValues (Maybe Text) Source

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

pmvDBInstanceIdentifier :: Lens' PendingModifiedValues (Maybe Text) Source

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

pmvEngineVersion :: Lens' PendingModifiedValues (Maybe Text) Source

Indicates the database engine version.

pmvIops :: Lens' PendingModifiedValues (Maybe Int) Source

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

pmvMasterUserPassword :: Lens' PendingModifiedValues (Maybe Text) Source

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

pmvMultiAZ :: Lens' PendingModifiedValues (Maybe Bool) Source

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

pmvPort :: Lens' PendingModifiedValues (Maybe Int) Source

Specifies the pending port for the DB instance.

pmvStorageType :: Lens' PendingModifiedValues (Maybe Text) Source

Specifies storage type to be associated with the DB instance.

VpcSecurityGroupMembership

vsgmStatus :: Lens' VpcSecurityGroupMembership (Maybe Text) Source

The status of the VPC security group.

Parameter

pAllowedValues :: Lens' Parameter (Maybe Text) Source

Specifies the valid range of values for the parameter.

pApplyMethod :: Lens' Parameter (Maybe ApplyMethod) Source

Indicates when to apply parameter updates.

pApplyType :: Lens' Parameter (Maybe Text) Source

Specifies the engine specific parameters type.

pDataType :: Lens' Parameter (Maybe Text) Source

Specifies the valid data type for the parameter.

pDescription :: Lens' Parameter (Maybe Text) Source

Provides a description of the parameter.

pIsModifiable :: 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.

pMinimumEngineVersion :: Lens' Parameter (Maybe Text) Source

The earliest engine version to which the parameter can apply.

pParameterName :: Lens' Parameter (Maybe Text) Source

Specifies the name of the parameter.

pParameterValue :: Lens' Parameter (Maybe Text) Source

Specifies the value of the parameter.

pSource :: Lens' Parameter (Maybe Text) Source

Indicates the source of the parameter value.

OptionGroupOptionSetting

ogosAllowedValues :: Lens' OptionGroupOptionSetting (Maybe Text) Source

Indicates the acceptable values for the option group option.

ogosApplyType :: Lens' OptionGroupOptionSetting (Maybe Text) Source

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

ogosDefaultValue :: Lens' OptionGroupOptionSetting (Maybe Text) Source

The default value for the option group option.

ogosIsModifiable :: Lens' OptionGroupOptionSetting (Maybe Bool) Source

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

ogosSettingDescription :: Lens' OptionGroupOptionSetting (Maybe Text) Source

The description of the option group option.

ogosSettingName :: Lens' OptionGroupOptionSetting (Maybe Text) Source

The name of the option group option.