diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -8,7 +8,11 @@ ## Description -Amazon Relational Database Service (Amazon RDS) is a web service that makes it easy to set up, operate, and scale a relational database in the cloud. It provides cost-efficient and resizable capacity while managing time-consuming database administration tasks, freeing you up to focus on your applications and business. + Amazon Relational Database Service (Amazon RDS) is a web service that makes + it easy to set up, operate, and scale a relational database in the cloud. It + provides cost-efficient and resizable capacity while managing time-consuming + database administration tasks, freeing you up to focus on your applications + and business. Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-rds) and [AWS API Reference](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/Welcome.html). diff --git a/amazonka-rds.cabal b/amazonka-rds.cabal --- a/amazonka-rds.cabal +++ b/amazonka-rds.cabal @@ -1,5 +1,5 @@ name: amazonka-rds -version: 0.0.1 +version: 0.0.2 synopsis: Amazon Relational Database Service SDK. homepage: https://github.com/brendanhay/amazonka license: OtherLicense @@ -13,11 +13,11 @@ cabal-version: >= 1.10 description: - Amazon Relational Database Service (Amazon RDS) is a web service that - makes it easy to set up, operate, and scale a relational database in - the cloud. It provides cost-efficient and resizable capacity while - managing time-consuming database administration tasks, freeing you up - to focus on your applications and business. + Amazon Relational Database Service (Amazon RDS) is a web service that makes + it easy to set up, operate, and scale a relational database in the cloud. It + provides cost-efficient and resizable capacity while managing time-consuming + database administration tasks, freeing you up to focus on your applications + and business. . /See:/ . @@ -95,5 +95,5 @@ other-modules: build-depends: - amazonka-core == 0.0.1.* + amazonka-core == 0.0.2.* , base >= 4.7 && < 5 diff --git a/gen/Network/AWS/RDS.hs b/gen/Network/AWS/RDS.hs --- a/gen/Network/AWS/RDS.hs +++ b/gen/Network/AWS/RDS.hs @@ -9,10 +9,10 @@ -- Portability : non-portable (GHC extensions) -- | Amazon Relational Database Service (Amazon RDS) is a web service that makes --- it easy to set up, operate, and scale a relational database in the cloud. --- It provides cost-efficient and resizable capacity while managing --- time-consuming database administration tasks, freeing you up to focus on --- your applications and business. +-- it easy to set up, operate, and scale a relational database in the cloud. It +-- provides cost-efficient and resizable capacity while managing time-consuming +-- database administration tasks, freeing you up to focus on your applications +-- and business. module Network.AWS.RDS ( module Network.AWS.RDS.AddSourceIdentifierToSubscription , module Network.AWS.RDS.AddTagsToResource diff --git a/gen/Network/AWS/RDS/AddSourceIdentifierToSubscription.hs b/gen/Network/AWS/RDS/AddSourceIdentifierToSubscription.hs --- a/gen/Network/AWS/RDS/AddSourceIdentifierToSubscription.hs +++ b/gen/Network/AWS/RDS/AddSourceIdentifierToSubscription.hs @@ -20,8 +20,7 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Adds a source identifier to an existing RDS event notification --- subscription. +-- | Adds a source identifier to an existing RDS event notification subscription. -- -- module Network.AWS.RDS.AddSourceIdentifierToSubscription @@ -69,20 +68,21 @@ } -- | The identifier of the event source to be added. An identifier must begin --- with a letter and must contain only ASCII letters, digits, and hyphens; --- it cannot end with a hyphen or contain two consecutive hyphens. --- Constraints: If the source type is a DB instance, then a --- DBInstanceIdentifier must be supplied. If the source type is a DB --- security group, a DBSecurityGroupName must be supplied. If the source --- type is a DB parameter group, a DBParameterGroupName must be supplied. If --- the source type is a DB snapshot, a DBSnapshotIdentifier must be --- supplied. +-- with a letter and must contain only ASCII letters, digits, and hyphens; it +-- cannot end with a hyphen or contain two consecutive hyphens. +-- +-- Constraints: +-- +-- If the source type is a DB instance, then a 'DBInstanceIdentifier' must be +-- supplied. If the source type is a DB security group, a 'DBSecurityGroupName' +-- must be supplied. If the source type is a DB parameter group, a 'DBParameterGroupName' must be supplied. If the source type is a DB snapshot, a 'DBSnapshotIdentifier' +-- must be supplied. asitsSourceIdentifier :: Lens' AddSourceIdentifierToSubscription Text asitsSourceIdentifier = lens _asitsSourceIdentifier (\s a -> s { _asitsSourceIdentifier = a }) --- | The name of the RDS event notification subscription you want to add a --- source identifier to. +-- | The name of the RDS event notification subscription you want to add a source +-- identifier to. asitsSubscriptionName :: Lens' AddSourceIdentifierToSubscription Text asitsSubscriptionName = lens _asitsSubscriptionName (\s a -> s { _asitsSubscriptionName = a }) diff --git a/gen/Network/AWS/RDS/AddTagsToResource.hs b/gen/Network/AWS/RDS/AddTagsToResource.hs --- a/gen/Network/AWS/RDS/AddTagsToResource.hs +++ b/gen/Network/AWS/RDS/AddTagsToResource.hs @@ -22,10 +22,10 @@ -- | Adds metadata tags to an Amazon RDS resource. These tags can also be used -- with cost allocation reporting to track cost associated with Amazon RDS --- resources, or used in Condition statement in IAM policy for Amazon RDS. For --- an overview on tagging Amazon RDS resources, see Tagging Amazon RDS --- Resources. +-- resources, or used in Condition statement in IAM policy for Amazon RDS. -- +-- For an overview on tagging Amazon RDS resources, see . +-- -- module Network.AWS.RDS.AddTagsToResource ( @@ -68,9 +68,8 @@ , _attrTags = mempty } --- | The Amazon RDS resource the tags will be added to. This value is an --- Amazon Resource Name (ARN). For information about creating an ARN, see --- Constructing an RDS Amazon Resource Name (ARN). +-- | The Amazon RDS resource the tags will be added to. This value is an Amazon +-- Resource Name (ARN). For information about creating an ARN, see . attrResourceName :: Lens' AddTagsToResource Text attrResourceName = lens _attrResourceName (\s a -> s { _attrResourceName = a }) diff --git a/gen/Network/AWS/RDS/AuthorizeDBSecurityGroupIngress.hs b/gen/Network/AWS/RDS/AuthorizeDBSecurityGroupIngress.hs --- a/gen/Network/AWS/RDS/AuthorizeDBSecurityGroupIngress.hs +++ b/gen/Network/AWS/RDS/AuthorizeDBSecurityGroupIngress.hs @@ -27,9 +27,10 @@ -- your database is running on the Internet. Required parameters for this API -- are one of CIDR range, EC2SecurityGroupId for VPC, or -- (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or --- EC2SecurityGroupId for non-VPC). For an overview of CIDR ranges, go to the --- Wikipedia Tutorial. +-- EC2SecurityGroupId for non-VPC). -- +-- For an overview of CIDR ranges, go to the . +-- -- module Network.AWS.RDS.AuthorizeDBSecurityGroupIngress ( @@ -99,27 +100,22 @@ lens _adbsgiDBSecurityGroupName (\s a -> s { _adbsgiDBSecurityGroupName = a }) --- | Id of the EC2 security group to authorize. For VPC DB security groups, --- EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId --- and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. +-- | Id of the EC2 security group to authorize. For VPC DB security groups, 'EC2SecurityGroupId' must be provided. Otherwise, EC2SecurityGroupOwnerId and either 'EC2SecurityGroupName' or 'EC2SecurityGroupId' must be provided. adbsgiEC2SecurityGroupId :: Lens' AuthorizeDBSecurityGroupIngress (Maybe Text) adbsgiEC2SecurityGroupId = lens _adbsgiEC2SecurityGroupId (\s a -> s { _adbsgiEC2SecurityGroupId = a }) --- | Name of the EC2 security group to authorize. For VPC DB security groups, --- EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId --- and either EC2SecurityGroupName or EC2SecurityGroupId must be provided. +-- | Name of the EC2 security group to authorize. For VPC DB security groups, 'EC2SecurityGroupId' must be provided. Otherwise, EC2SecurityGroupOwnerId and either 'EC2SecurityGroupName' or 'EC2SecurityGroupId' must be provided. adbsgiEC2SecurityGroupName :: Lens' AuthorizeDBSecurityGroupIngress (Maybe Text) adbsgiEC2SecurityGroupName = lens _adbsgiEC2SecurityGroupName (\s a -> s { _adbsgiEC2SecurityGroupName = a }) --- | AWS Account Number of the owner of the EC2 security group specified in --- the EC2SecurityGroupName parameter. The AWS Access Key ID is not an --- acceptable value. For VPC DB security groups, EC2SecurityGroupId must be --- provided. Otherwise, EC2SecurityGroupOwnerId and either --- EC2SecurityGroupName or EC2SecurityGroupId must be provided. +-- | AWS Account Number of the owner of the EC2 security group specified in the +-- EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable +-- value. For VPC DB security groups, 'EC2SecurityGroupId' must be provided. +-- Otherwise, EC2SecurityGroupOwnerId and either 'EC2SecurityGroupName' or 'EC2SecurityGroupId' must be provided. adbsgiEC2SecurityGroupOwnerId :: Lens' AuthorizeDBSecurityGroupIngress (Maybe Text) adbsgiEC2SecurityGroupOwnerId = lens _adbsgiEC2SecurityGroupOwnerId diff --git a/gen/Network/AWS/RDS/CopyDBParameterGroup.hs b/gen/Network/AWS/RDS/CopyDBParameterGroup.hs --- a/gen/Network/AWS/RDS/CopyDBParameterGroup.hs +++ b/gen/Network/AWS/RDS/CopyDBParameterGroup.hs @@ -78,13 +78,17 @@ , _cdbpgTags = mempty } --- | The identifier or ARN for the source DB Parameter Group. Constraints: +-- | The identifier or ARN for the source DB Parameter Group. +-- +-- Constraints: +-- -- Must specify a valid DB Parameter Group. If the source DB Parameter Group -- is in the same region as the copy, specify a valid DB Parameter Group -- identifier, or a valid ARN. If the source DB Parameter Group is in a --- different region than the copy, specify a valid DB parameter group ARN. --- Example: my-db-param-group Example: --- arn:aws:rds:us-west-2:123456789012:pg:special-parameters. +-- different region than the copy, specify a valid DB parameter group ARN. Example: +-- 'my-db-param-group' +-- +-- Example: 'arn:aws:rds:us-west-2:123456789012:pg:special-parameters' cdbpgSourceDBParameterGroupIdentifier :: Lens' CopyDBParameterGroup Text cdbpgSourceDBParameterGroupIdentifier = lens _cdbpgSourceDBParameterGroupIdentifier @@ -99,10 +103,13 @@ lens _cdbpgTargetDBParameterGroupDescription (\s a -> s { _cdbpgTargetDBParameterGroupDescription = a }) --- | The identifier for the copied DB Parameter Group. Constraints: Cannot be --- null, empty, or blank Must contain from 1 to 255 alphanumeric characters --- or hyphens First character must be a letter Cannot end with a hyphen or --- contain two consecutive hyphens Example: my-db-parameter-group. +-- | The identifier for the copied DB Parameter Group. +-- +-- Constraints: +-- +-- Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric +-- characters or hyphens First character must be a letter Cannot end with a +-- hyphen or contain two consecutive hyphens Example: 'my-db-parameter-group' cdbpgTargetDBParameterGroupIdentifier :: Lens' CopyDBParameterGroup Text cdbpgTargetDBParameterGroupIdentifier = lens _cdbpgTargetDBParameterGroupIdentifier diff --git a/gen/Network/AWS/RDS/CopyDBSnapshot.hs b/gen/Network/AWS/RDS/CopyDBSnapshot.hs --- a/gen/Network/AWS/RDS/CopyDBSnapshot.hs +++ b/gen/Network/AWS/RDS/CopyDBSnapshot.hs @@ -73,14 +73,16 @@ , _cdbsTags = mempty } --- | The identifier for the source DB snapshot. Constraints: Must specify a --- valid system snapshot in the "available" state. If the source snapshot is --- in the same region as the copy, specify a valid DB snapshot identifier. --- If the source snapshot is in a different region than the copy, specify a --- valid DB snapshot ARN. For more information, go to Copying a DB Snapshot. --- Example: rds:mydb-2012-04-02-00-01 Example: --- arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805. --- +-- | The identifier for the source DB snapshot. +-- +-- Constraints: +-- +-- Must specify a valid system snapshot in the "available" state. If the +-- source snapshot is in the same region as the copy, specify a valid DB +-- snapshot identifier. If the source snapshot is in a different region than the +-- copy, specify a valid DB snapshot ARN. For more information, go to . Example: 'rds:mydb-2012-04-02-00-01' +-- +-- Example: 'arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805' cdbsSourceDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text cdbsSourceDBSnapshotIdentifier = lens _cdbsSourceDBSnapshotIdentifier @@ -89,10 +91,13 @@ cdbsTags :: Lens' CopyDBSnapshot [Tag] cdbsTags = lens _cdbsTags (\s a -> s { _cdbsTags = a }) . _List --- | The identifier for the copied snapshot. Constraints: Cannot be null, --- empty, or blank Must contain from 1 to 255 alphanumeric characters or --- hyphens First character must be a letter Cannot end with a hyphen or --- contain two consecutive hyphens Example: my-db-snapshot. +-- | The identifier for the copied snapshot. +-- +-- Constraints: +-- +-- Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric +-- characters or hyphens First character must be a letter Cannot end with a +-- hyphen or contain two consecutive hyphens Example: 'my-db-snapshot' cdbsTargetDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text cdbsTargetDBSnapshotIdentifier = lens _cdbsTargetDBSnapshotIdentifier diff --git a/gen/Network/AWS/RDS/CopyOptionGroup.hs b/gen/Network/AWS/RDS/CopyOptionGroup.hs --- a/gen/Network/AWS/RDS/CopyOptionGroup.hs +++ b/gen/Network/AWS/RDS/CopyOptionGroup.hs @@ -78,12 +78,16 @@ , _cog1Tags = mempty } --- | The identifier or ARN for the source Option Group. Constraints: Must --- specify a valid Option Group. If the source Option Group is in the same --- region as the copy, specify a valid Option Group identifier, or a valid +-- | The identifier or ARN for the source Option Group. +-- +-- Constraints: +-- +-- Must specify a valid Option Group. If the source Option Group is in the +-- same region as the copy, specify a valid Option Group identifier, or a valid -- ARN. If the source Option Group is in a different region than the copy, --- specify a valid Option group ARN. Example: my-option-group Example: --- arn:aws:rds:us-west-2:123456789012:og:special-options. +-- specify a valid Option group ARN. Example: 'my-option-group' +-- +-- Example: 'arn:aws:rds:us-west-2:123456789012:og:special-options' cog1SourceOptionGroupIdentifier :: Lens' CopyOptionGroup Text cog1SourceOptionGroupIdentifier = lens _cog1SourceOptionGroupIdentifier @@ -98,10 +102,13 @@ lens _cog1TargetOptionGroupDescription (\s a -> s { _cog1TargetOptionGroupDescription = a }) --- | The identifier for the copied Option Group. Constraints: Cannot be null, --- empty, or blank Must contain from 1 to 255 alphanumeric characters or --- hyphens First character must be a letter Cannot end with a hyphen or --- contain two consecutive hyphens Example: my-option-group. +-- | The identifier for the copied Option Group. +-- +-- Constraints: +-- +-- Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric +-- characters or hyphens First character must be a letter Cannot end with a +-- hyphen or contain two consecutive hyphens Example: 'my-option-group' cog1TargetOptionGroupIdentifier :: Lens' CopyOptionGroup Text cog1TargetOptionGroupIdentifier = lens _cog1TargetOptionGroupIdentifier diff --git a/gen/Network/AWS/RDS/CreateDBInstance.hs b/gen/Network/AWS/RDS/CreateDBInstance.hs --- a/gen/Network/AWS/RDS/CreateDBInstance.hs +++ b/gen/Network/AWS/RDS/CreateDBInstance.hs @@ -202,149 +202,243 @@ } -- | The amount of storage (in gigabytes) to be initially allocated for the --- database instance. Type: Integer MySQL Constraints: Must be an integer --- from 5 to 3072. PostgreSQL Constraints: Must be an integer from 5 to --- 3072. Oracle Constraints: Must be an integer from 10 to 3072. SQL Server +-- database instance. +-- +-- Type: Integer +-- +-- MySQL +-- +-- Constraints: Must be an integer from 5 to 3072. +-- +-- PostgreSQL +-- +-- Constraints: Must be an integer from 5 to 3072. +-- +-- Oracle +-- +-- Constraints: Must be an integer from 10 to 3072. +-- +-- SQL Server +-- -- Constraints: Must be an integer from 200 to 1024 (Standard Edition and --- Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition). +-- Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition) cdbiAllocatedStorage :: Lens' CreateDBInstance Int cdbiAllocatedStorage = lens _cdbiAllocatedStorage (\s a -> s { _cdbiAllocatedStorage = a }) --- | Indicates that minor engine upgrades will be applied automatically to the --- DB instance during the maintenance window. Default: true. +-- | Indicates that minor engine upgrades will be applied automatically to the DB +-- instance during the maintenance window. +-- +-- Default: 'true' cdbiAutoMinorVersionUpgrade :: Lens' CreateDBInstance (Maybe Bool) cdbiAutoMinorVersionUpgrade = lens _cdbiAutoMinorVersionUpgrade (\s a -> s { _cdbiAutoMinorVersionUpgrade = a }) -- | The EC2 Availability Zone that the database instance will be created in. +-- -- Default: A random, system-chosen Availability Zone in the endpoint's --- region. Example: us-east-1d Constraint: The AvailabilityZone parameter --- cannot be specified if the MultiAZ parameter is set to true. The --- specified Availability Zone must be in the same region as the current --- endpoint. +-- region. +-- +-- Example: 'us-east-1d' +-- +-- Constraint: The AvailabilityZone parameter cannot be specified if the +-- MultiAZ parameter is set to 'true'. The specified Availability Zone must be in +-- the same region as the current endpoint. cdbiAvailabilityZone :: Lens' CreateDBInstance (Maybe Text) cdbiAvailabilityZone = lens _cdbiAvailabilityZone (\s a -> s { _cdbiAvailabilityZone = a }) -- | The number of days for which automated backups are retained. Setting this --- parameter to a positive number enables backups. Setting this parameter to --- 0 disables automated backups. Default: 1 Constraints: Must be a value --- from 0 to 35 Cannot be set to 0 if the DB instance is a source to read --- replicas. +-- parameter to a positive number enables backups. Setting this parameter to 0 +-- disables automated backups. +-- +-- Default: 1 +-- +-- Constraints: +-- +-- Must be a value from 0 to 35 Cannot be set to 0 if the DB instance is a +-- source to read replicas cdbiBackupRetentionPeriod :: Lens' CreateDBInstance (Maybe Int) cdbiBackupRetentionPeriod = lens _cdbiBackupRetentionPeriod (\s a -> s { _cdbiBackupRetentionPeriod = a }) --- | For supported engines, indicates that the DB instance should be --- associated with the specified CharacterSet. +-- | For supported engines, indicates that the DB instance should be associated +-- with the specified CharacterSet. cdbiCharacterSetName :: Lens' CreateDBInstance (Maybe Text) cdbiCharacterSetName = lens _cdbiCharacterSetName (\s a -> s { _cdbiCharacterSetName = a }) --- | The compute and memory capacity of the DB instance. Valid Values: --- db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | --- db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large --- | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | --- db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small --- | db.t2.medium. +-- | The compute and memory capacity of the DB instance. +-- +-- Valid Values: 'db.t1.micro | db.m1.small | db.m1.medium | db.m1.large |db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium |db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge |db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small |db.t2.medium' cdbiDBInstanceClass :: Lens' CreateDBInstance Text cdbiDBInstanceClass = lens _cdbiDBInstanceClass (\s a -> s { _cdbiDBInstanceClass = a }) --- | The DB instance identifier. This parameter is stored as a lowercase --- string. Constraints: Must contain from 1 to 63 alphanumeric characters or --- hyphens (1 to 15 for SQL Server). First character must be a letter. --- Cannot end with a hyphen or contain two consecutive hyphens. Example: --- mydbinstance. +-- | The DB instance identifier. This parameter is stored as a lowercase string. +-- +-- Constraints: +-- +-- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for +-- SQL Server). First character must be a letter. Cannot end with a hyphen or +-- contain two consecutive hyphens. Example: 'mydbinstance' cdbiDBInstanceIdentifier :: Lens' CreateDBInstance Text cdbiDBInstanceIdentifier = lens _cdbiDBInstanceIdentifier (\s a -> s { _cdbiDBInstanceIdentifier = a }) --- | The meaning of this parameter differs according to the database engine --- you use. Type: String MySQL The name of the database to create when the --- DB instance is created. If this parameter is not specified, no database --- is created in the DB instance. Constraints: Must contain 1 to 64 --- alphanumeric characters Cannot be a word reserved by the specified --- database engine PostgreSQL The name of the database to create when the DB --- instance is created. If this parameter is not specified, no database is --- created in the DB instance. Constraints: Must contain 1 to 63 --- alphanumeric characters Must begin with a letter or an underscore. --- Subsequent characters can be letters, underscores, or digits (0-9). --- Cannot be a word reserved by the specified database engine Oracle The --- Oracle System ID (SID) of the created DB instance. Default: ORCL --- Constraints: Cannot be longer than 8 characters SQL Server Not --- applicable. Must be null. +-- | The meaning of this parameter differs according to the database engine you +-- use. +-- +-- Type: String +-- +-- MySQL +-- +-- The name of the database to create when the DB instance is created. If this +-- parameter is not specified, no database is created in the DB instance. +-- +-- Constraints: +-- +-- Must contain 1 to 64 alphanumeric characters Cannot be a word reserved by +-- the specified database engine PostgreSQL +-- +-- The name of the database to create when the DB instance is created. If this +-- parameter is not specified, no database is created in the DB instance. +-- +-- Constraints: +-- +-- Must contain 1 to 63 alphanumeric characters Must begin with a letter or an +-- underscore. Subsequent characters can be letters, underscores, or digits +-- (0-9). Cannot be a word reserved by the specified database engine Oracle +-- +-- The Oracle System ID (SID) of the created DB instance. +-- +-- Default: 'ORCL' +-- +-- Constraints: +-- +-- Cannot be longer than 8 characters SQL Server +-- +-- Not applicable. Must be null. cdbiDBName :: Lens' CreateDBInstance (Maybe Text) cdbiDBName = lens _cdbiDBName (\s a -> s { _cdbiDBName = a }) -- | The name of the DB parameter group to associate with this DB instance. If -- this argument is omitted, the default DBParameterGroup for the specified --- engine will be used. Constraints: Must be 1 to 255 alphanumeric --- characters First character must be a letter Cannot end with a hyphen or --- contain two consecutive hyphens. +-- engine will be used. +-- +-- Constraints: +-- +-- Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens +-- cdbiDBParameterGroupName :: Lens' CreateDBInstance (Maybe Text) cdbiDBParameterGroupName = lens _cdbiDBParameterGroupName (\s a -> s { _cdbiDBParameterGroupName = a }) --- | A list of DB security groups to associate with this DB instance. Default: --- The default DB security group for the database engine. +-- | A list of DB security groups to associate with this DB instance. +-- +-- Default: The default DB security group for the database engine. cdbiDBSecurityGroups :: Lens' CreateDBInstance [Text] cdbiDBSecurityGroups = lens _cdbiDBSecurityGroups (\s a -> s { _cdbiDBSecurityGroups = a }) . _List --- | A DB subnet group to associate with this DB instance. If there is no DB --- subnet group, then it is a non-VPC DB instance. +-- | A DB subnet group to associate with this DB instance. +-- +-- If there is no DB subnet group, then it is a non-VPC DB instance. cdbiDBSubnetGroupName :: Lens' CreateDBInstance (Maybe Text) cdbiDBSubnetGroupName = lens _cdbiDBSubnetGroupName (\s a -> s { _cdbiDBSubnetGroupName = a }) --- | The name of the database engine to be used for this instance. Valid --- Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | --- sqlserver-se | sqlserver-ex | sqlserver-web | postgres. +-- | The name of the database engine to be used for this instance. +-- +-- Valid Values: 'MySQL' | 'oracle-se1' | 'oracle-se' | 'oracle-ee' | 'sqlserver-ee' | 'sqlserver-se' | 'sqlserver-ex' | 'sqlserver-web' | 'postgres' cdbiEngine :: Lens' CreateDBInstance Text cdbiEngine = lens _cdbiEngine (\s a -> s { _cdbiEngine = a }) --- | The version number of the database engine to use. MySQL Example: 5.1.42 --- Type: String PostgreSQL Example: 9.3 Type: String Oracle Example: --- 11.2.0.2.v2 Type: String SQL Server Example: 10.50.2789.0.v1. +-- | The version number of the database engine to use. +-- +-- MySQL +-- +-- Example: '5.1.42' +-- +-- Type: String +-- +-- PostgreSQL +-- +-- Example: '9.3' +-- +-- Type: String +-- +-- Oracle +-- +-- Example: '11.2.0.2.v2' +-- +-- Type: String +-- +-- SQL Server +-- +-- Example: '10.50.2789.0.v1' cdbiEngineVersion :: Lens' CreateDBInstance (Maybe Text) cdbiEngineVersion = lens _cdbiEngineVersion (\s a -> s { _cdbiEngineVersion = a }) -- | The amount of Provisioned IOPS (input/output operations per second) to be --- initially allocated for the DB instance. Constraints: To use PIOPS, this --- value must be an integer greater than 1000. +-- initially allocated for the DB instance. +-- +-- Constraints: To use PIOPS, this value must be an integer greater than 1000. cdbiIops :: Lens' CreateDBInstance (Maybe Int) cdbiIops = lens _cdbiIops (\s a -> s { _cdbiIops = a }) --- | License model information for this DB instance. Valid values: --- license-included | bring-your-own-license | general-public-license. +-- | License model information for this DB instance. +-- +-- Valid values: 'license-included' | 'bring-your-own-license' | 'general-public-license' cdbiLicenseModel :: Lens' CreateDBInstance (Maybe Text) cdbiLicenseModel = lens _cdbiLicenseModel (\s a -> s { _cdbiLicenseModel = a }) -- | The password for the master database user. Can be any printable ASCII --- character except "/", """, or "@". Type: String MySQL Constraints: Must --- contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 --- to 30 characters. SQL Server Constraints: Must contain from 8 to 128 --- characters. +-- character except "/", """, or "@". +-- +-- Type: String +-- +-- MySQL +-- +-- Constraints: Must contain from 8 to 41 characters. +-- +-- Oracle +-- +-- Constraints: Must contain from 8 to 30 characters. +-- +-- SQL Server +-- +-- Constraints: Must contain from 8 to 128 characters. cdbiMasterUserPassword :: Lens' CreateDBInstance Text cdbiMasterUserPassword = lens _cdbiMasterUserPassword (\s a -> s { _cdbiMasterUserPassword = a }) --- | The name of master user for the client DB instance. MySQL Constraints: --- Must be 1 to 16 alphanumeric characters. First character must be a --- letter. Cannot be a reserved word for the chosen database engine. Type: --- String Oracle Constraints: Must be 1 to 30 alphanumeric characters. First --- character must be a letter. Cannot be a reserved word for the chosen --- database engine. SQL Server Constraints: Must be 1 to 128 alphanumeric --- characters. First character must be a letter. Cannot be a reserved word --- for the chosen database engine. +-- | The name of master user for the client DB instance. +-- +-- MySQL +-- +-- Constraints: +-- +-- Must be 1 to 16 alphanumeric characters. First character must be a letter. Cannot be a reserved word for the chosen database engine. +-- Type: String +-- +-- Oracle +-- +-- Constraints: +-- +-- Must be 1 to 30 alphanumeric characters. First character must be a letter. Cannot be a reserved word for the chosen database engine. +-- SQL Server +-- +-- Constraints: +-- +-- Must be 1 to 128 alphanumeric characters. First character must be a letter. +-- Cannot be a reserved word for the chosen database engine. cdbiMasterUsername :: Lens' CreateDBInstance Text cdbiMasterUsername = lens _cdbiMasterUsername (\s a -> s { _cdbiMasterUsername = a }) @@ -355,28 +449,56 @@ cdbiMultiAZ = lens _cdbiMultiAZ (\s a -> s { _cdbiMultiAZ = a }) -- | Indicates that the DB instance should be associated with the specified --- option group. Permanent options, such as the TDE option for Oracle --- Advanced Security TDE, cannot be removed from an option group, and that --- option group cannot be removed from a DB instance once it is associated --- with a DB instance. +-- option group. +-- +-- Permanent options, such as the TDE option for Oracle Advanced Security TDE, +-- cannot be removed from an option group, and that option group cannot be +-- removed from a DB instance once it is associated with a DB instance cdbiOptionGroupName :: Lens' CreateDBInstance (Maybe Text) cdbiOptionGroupName = lens _cdbiOptionGroupName (\s a -> s { _cdbiOptionGroupName = a }) --- | The port number on which the database accepts connections. MySQL Default: --- 3306 Valid Values: 1150-65535 Type: Integer PostgreSQL Default: 5432 --- Valid Values: 1150-65535 Type: Integer Oracle Default: 1521 Valid Values: --- 1150-65535 SQL Server Default: 1433 Valid Values: 1150-65535 except for --- 1434, 3389, 47001, 49152, and 49152 through 49156. +-- | The port number on which the database accepts connections. +-- +-- MySQL +-- +-- Default: '3306' +-- +-- Valid Values: '1150-65535' +-- +-- Type: Integer +-- +-- PostgreSQL +-- +-- Default: '5432' +-- +-- Valid Values: '1150-65535' +-- +-- Type: Integer +-- +-- Oracle +-- +-- Default: '1521' +-- +-- Valid Values: '1150-65535' +-- +-- SQL Server +-- +-- Default: '1433' +-- +-- Valid Values: '1150-65535' except for '1434', '3389', '47001', '49152', and '49152' +-- through '49156'. cdbiPort :: Lens' CreateDBInstance (Maybe Int) cdbiPort = lens _cdbiPort (\s a -> s { _cdbiPort = a }) --- | The daily time range during which automated backups are created if --- automated backups are enabled, using the BackupRetentionPeriod parameter. --- Default: A 30-minute window selected at random from an 8-hour block of --- time per region. See the Amazon RDS User Guide for the time blocks for --- each region from which the default backup windows are assigned. --- Constraints: Must be in the format hh24:mi-hh24:mi. Times should be +-- | The daily time range during which automated backups are created if automated +-- backups are enabled, using the 'BackupRetentionPeriod' parameter. +-- +-- Default: A 30-minute window selected at random from an 8-hour block of time +-- per region. See the Amazon RDS User Guide for the time blocks for each region +-- from which the default backup windows are assigned. +-- +-- Constraints: Must be in the format 'hh24:mi-hh24:mi'. Times should be -- Universal Time Coordinated (UTC). Must not conflict with the preferred -- maintenance window. Must be at least 30 minutes. cdbiPreferredBackupWindow :: Lens' CreateDBInstance (Maybe Text) @@ -385,35 +507,44 @@ (\s a -> s { _cdbiPreferredBackupWindow = a }) -- | The weekly time range (in UTC) during which system maintenance can occur. --- Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at --- random from an 8-hour block of time per region, occurring on a random day --- of the week. To see the time blocks available, see Adjusting the --- Preferred Maintenance Window in the Amazon RDS User Guide. Valid Days: --- Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. +-- +-- Format: 'ddd:hh24:mi-ddd:hh24:mi' +-- +-- Default: A 30-minute window selected at random from an 8-hour block of time +-- per region, occurring on a random day of the week. To see the time blocks +-- available, see in the Amazon RDS +-- User Guide. +-- +-- Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun +-- +-- Constraints: Minimum 30-minute window. cdbiPreferredMaintenanceWindow :: Lens' CreateDBInstance (Maybe Text) cdbiPreferredMaintenanceWindow = lens _cdbiPreferredMaintenanceWindow (\s a -> s { _cdbiPreferredMaintenanceWindow = a }) -- | 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 +-- 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 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. +-- been set, the DB instance will be private. cdbiPubliclyAccessible :: Lens' CreateDBInstance (Maybe Bool) cdbiPubliclyAccessible = lens _cdbiPubliclyAccessible (\s a -> s { _cdbiPubliclyAccessible = a }) --- | Specifies storage type to be associated with the DB Instance. Valid --- values: standard | gp2 | io1 If you specify io1, you must also include a --- value for the Iops parameter. +-- | Specifies storage type to be associated with the DB Instance. +-- +-- Valid values: 'standard | gp2 | io1' +-- +-- If you specify 'io1', you must also include a value for the 'Iops' parameter. cdbiStorageType :: Lens' CreateDBInstance (Maybe Text) cdbiStorageType = lens _cdbiStorageType (\s a -> s { _cdbiStorageType = a }) @@ -434,8 +565,8 @@ (\s a -> s { _cdbiTdeCredentialPassword = a }) -- | A list of EC2 VPC security groups to associate with this DB instance. --- Default: The default EC2 VPC security group for the DB subnet group's --- VPC. +-- +-- Default: The default EC2 VPC security group for the DB subnet group's VPC. cdbiVpcSecurityGroupIds :: Lens' CreateDBInstance [Text] cdbiVpcSecurityGroupIds = lens _cdbiVpcSecurityGroupIds (\s a -> s { _cdbiVpcSecurityGroupIds = a }) diff --git a/gen/Network/AWS/RDS/CreateDBInstanceReadReplica.hs b/gen/Network/AWS/RDS/CreateDBInstanceReadReplica.hs --- a/gen/Network/AWS/RDS/CreateDBInstanceReadReplica.hs +++ b/gen/Network/AWS/RDS/CreateDBInstanceReadReplica.hs @@ -21,12 +21,16 @@ -- Portability : non-portable (GHC extensions) -- | Creates a DB instance that acts as a read replica of a source DB instance. +-- -- All read replica DB instances are created as Single-AZ deployments with -- backups disabled. All other DB instance attributes (including DB security -- groups and DB parameter groups) are inherited from the source DB instance, --- except as specified below. The source DB instance must have backup --- retention enabled. +-- except as specified below. -- +-- The source DB instance must have backup retention enabled. +-- +-- +-- -- module Network.AWS.RDS.CreateDBInstanceReadReplica ( @@ -123,49 +127,53 @@ } -- | Indicates that minor engine upgrades will be applied automatically to the --- read replica during the maintenance window. Default: Inherits from the --- source DB instance. +-- read replica during the maintenance window. +-- +-- Default: Inherits from the source DB instance cdbirrAutoMinorVersionUpgrade :: Lens' CreateDBInstanceReadReplica (Maybe Bool) cdbirrAutoMinorVersionUpgrade = lens _cdbirrAutoMinorVersionUpgrade (\s a -> s { _cdbirrAutoMinorVersionUpgrade = a }) --- | The Amazon EC2 Availability Zone that the read replica will be created --- in. Default: A random, system-chosen Availability Zone in the endpoint's --- region. Example: us-east-1d. +-- | The Amazon EC2 Availability Zone that the read replica will be created in. +-- +-- Default: A random, system-chosen Availability Zone in the endpoint's +-- region. +-- +-- Example: 'us-east-1d' cdbirrAvailabilityZone :: Lens' CreateDBInstanceReadReplica (Maybe Text) cdbirrAvailabilityZone = lens _cdbirrAvailabilityZone (\s a -> s { _cdbirrAvailabilityZone = a }) --- | The compute and memory capacity of the read replica. Valid Values: --- db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge --- |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | --- db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge --- | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | --- db.t2.medium Default: Inherits from the source DB instance. +-- | The compute and memory capacity of the read replica. +-- +-- Valid Values: 'db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge |db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large |db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge |db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium' +-- +-- Default: Inherits from the source DB instance. cdbirrDBInstanceClass :: Lens' CreateDBInstanceReadReplica (Maybe Text) cdbirrDBInstanceClass = lens _cdbirrDBInstanceClass (\s a -> s { _cdbirrDBInstanceClass = a }) --- | The DB instance identifier of the read replica. This is the unique key --- that identifies a DB instance. This parameter is stored as a lowercase --- string. +-- | The DB instance identifier of the read replica. This is the unique key that +-- identifies a DB instance. This parameter is stored as a lowercase string. cdbirrDBInstanceIdentifier :: Lens' CreateDBInstanceReadReplica Text cdbirrDBInstanceIdentifier = lens _cdbirrDBInstanceIdentifier (\s a -> s { _cdbirrDBInstanceIdentifier = a }) --- | Specifies a DB subnet group for the DB instance. The new DB instance will --- be created in the VPC associated with the DB subnet group. If no DB --- subnet group is specified, then the new DB instance is not created in a --- VPC. Constraints: Can only be specified if the source DB instance --- identifier specifies a DB instance in another region. The specified DB --- subnet group must be in the same region in which the operation is --- running. All read replicas in one region that are created from the same --- source DB instance must either: Specify DB subnet groups from the same --- VPC. All these read replicas will be created in the same VPC. Not specify --- a DB subnet group. All these read replicas will be created outside of any --- VPC. +-- | Specifies a DB subnet group for the DB instance. The new DB instance will be +-- created in the VPC associated with the DB subnet group. If no DB subnet group +-- is specified, then the new DB instance is not created in a VPC. +-- +-- Constraints: +-- +-- Can only be specified if the source DB instance identifier specifies a DB +-- instance in another region. The specified DB subnet group must be in the same +-- region in which the operation is running. All read replicas in one region +-- that are created from the same source DB instance must either: Specify DB +-- subnet groups from the same VPC. All these read replicas will be created in +-- the same VPC. Not specify a DB subnet group. All these read replicas will be +-- created outside of any VPC. cdbirrDBSubnetGroupName :: Lens' CreateDBInstanceReadReplica (Maybe Text) cdbirrDBSubnetGroupName = lens _cdbirrDBSubnetGroupName (\s a -> s { _cdbirrDBSubnetGroupName = a }) @@ -181,46 +189,54 @@ cdbirrOptionGroupName = lens _cdbirrOptionGroupName (\s a -> s { _cdbirrOptionGroupName = a }) --- | The port number that the DB instance uses for connections. Default: --- Inherits from the source DB instance Valid Values: 1150-65535. +-- | The port number that the DB instance uses for connections. +-- +-- Default: Inherits from the source DB instance +-- +-- Valid Values: '1150-65535' cdbirrPort :: Lens' CreateDBInstanceReadReplica (Maybe Int) cdbirrPort = lens _cdbirrPort (\s a -> s { _cdbirrPort = a }) -- | 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 +-- 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 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. +-- been set, the DB instance will be private. cdbirrPubliclyAccessible :: Lens' CreateDBInstanceReadReplica (Maybe Bool) cdbirrPubliclyAccessible = lens _cdbirrPubliclyAccessible (\s a -> s { _cdbirrPubliclyAccessible = a }) --- | The identifier of the DB instance that will act as the source for the --- read replica. Each DB instance can have up to five read replicas. --- Constraints: Must be the identifier of an existing DB instance. Can --- specify a DB instance that is a read replica only if the source is --- running MySQL 5.6. The specified DB instance must have automatic backups --- enabled, its backup retention period must be greater than 0. If the --- source DB instance is in the same region as the read replica, specify a --- valid DB instance identifier. If the source DB instance is in a different --- region than the read replica, specify a valid DB instance ARN. For more --- information, go to Constructing a Amazon RDS Amazon Resource Name (ARN). +-- | The identifier of the DB instance that will act as the source for the read +-- replica. Each DB instance can have up to five read replicas. +-- +-- Constraints: +-- +-- Must be the identifier of an existing DB instance. Can specify a DB +-- instance that is a read replica only if the source is running MySQL 5.6. The +-- specified DB instance must have automatic backups enabled, its backup +-- retention period must be greater than 0. If the source DB instance is in the +-- same region as the read replica, specify a valid DB instance identifier. If +-- the source DB instance is in a different region than the read replica, +-- specify a valid DB instance ARN. For more information, go to . cdbirrSourceDBInstanceIdentifier :: Lens' CreateDBInstanceReadReplica Text cdbirrSourceDBInstanceIdentifier = lens _cdbirrSourceDBInstanceIdentifier (\s a -> s { _cdbirrSourceDBInstanceIdentifier = a }) --- | Specifies storage type to be associated with the DB Instance read --- replica. Valid values: standard | gp2 | io1 If you specify io1, you must --- also include a value for the Iops parameter. +-- | Specifies storage type to be associated with the DB Instance read replica. +-- +-- Valid values: 'standard | gp2 | io1' +-- +-- If you specify 'io1', you must also include a value for the 'Iops' parameter. cdbirrStorageType :: Lens' CreateDBInstanceReadReplica (Maybe Text) cdbirrStorageType = lens _cdbirrStorageType (\s a -> s { _cdbirrStorageType = a }) diff --git a/gen/Network/AWS/RDS/CreateDBParameterGroup.hs b/gen/Network/AWS/RDS/CreateDBParameterGroup.hs --- a/gen/Network/AWS/RDS/CreateDBParameterGroup.hs +++ b/gen/Network/AWS/RDS/CreateDBParameterGroup.hs @@ -20,25 +20,27 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Creates a new DB parameter group. A DB parameter group is initially created --- with the default parameters for the database engine used by the DB --- instance. To provide custom values for any of the parameters, you must --- modify the group after creating it using ModifyDBParameterGroup. Once --- you've created a DB parameter group, you need to associate it with your DB --- instance using ModifyDBInstance. When you associate a new DB parameter --- group with a running DB instance, you need to reboot the DB instance --- without failover for the new DB parameter group and associated settings to --- take effect. After you create a DB parameter group, you should wait at --- least 5 minutes before creating your first DB instance that uses that DB --- parameter group as the default parameter group. This allows Amazon RDS to --- fully complete the create action before the parameter group is used as the --- default for a new DB instance. This is especially important for parameters --- that are critical when creating the default database for a DB instance, --- such as the character set for the default database defined by the --- character_set_database parameter. You can use the Parameter Groups option --- of the Amazon RDS console or the DescribeDBParameters command to verify --- that your DB parameter group has been created or modified. +-- | Creates a new DB parameter group. -- +-- A DB parameter group is initially created with the default parameters for +-- the database engine used by the DB instance. To provide custom values for any +-- of the parameters, you must modify the group after creating it using /ModifyDBParameterGroup/. Once you've created a DB parameter group, you need to associate it with +-- your DB instance using /ModifyDBInstance/. When you associate a new DB +-- parameter group with a running DB instance, you need to reboot the DB +-- instance without failover for the new DB parameter group and associated +-- settings to take effect. +-- +-- After you create a DB parameter group, you should wait at least 5 minutes +-- before creating your first DB instance that uses that DB parameter group as +-- the default parameter group. This allows Amazon RDS to fully complete the +-- create action before the parameter group is used as the default for a new DB +-- instance. This is especially important for parameters that are critical when +-- creating the default database for a DB instance, such as the character set +-- for the default database defined by the 'character_set_database' parameter. You +-- can use the /Parameter Groups/ option of the or the /DescribeDBParameters/ command to verify that your DB parameter group has been created or modified. +-- +-- +-- -- module Network.AWS.RDS.CreateDBParameterGroup ( @@ -95,18 +97,21 @@ , _cdbpg1Tags = mempty } --- | The DB parameter group family name. A DB parameter group can be --- associated with one and only one DB parameter group family, and can be --- applied only to a DB instance running a database engine and engine --- version compatible with that DB parameter group family. +-- | The DB parameter group family name. A DB parameter group can be associated +-- with one and only one DB parameter group family, and can be applied only to a +-- DB instance running a database engine and engine version compatible with that +-- DB parameter group family. cdbpg1DBParameterGroupFamily :: Lens' CreateDBParameterGroup Text cdbpg1DBParameterGroupFamily = lens _cdbpg1DBParameterGroupFamily (\s a -> s { _cdbpg1DBParameterGroupFamily = a }) --- | The name of the DB 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. +-- | The name of the DB 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 +-- cdbpg1DBParameterGroupName :: Lens' CreateDBParameterGroup Text cdbpg1DBParameterGroupName = lens _cdbpg1DBParameterGroupName diff --git a/gen/Network/AWS/RDS/CreateDBSecurityGroup.hs b/gen/Network/AWS/RDS/CreateDBSecurityGroup.hs --- a/gen/Network/AWS/RDS/CreateDBSecurityGroup.hs +++ b/gen/Network/AWS/RDS/CreateDBSecurityGroup.hs @@ -80,10 +80,12 @@ (\s a -> s { _cdbsgDBSecurityGroupDescription = a }) -- | The name for the DB security group. This value is stored as a lowercase --- string. Constraints: Must be 1 to 255 alphanumeric characters First --- character must be a letter Cannot end with a hyphen or contain two --- consecutive hyphens Must not be "Default" May not contain spaces Example: --- mysecuritygroup. +-- string. +-- +-- Constraints: +-- +-- Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens +-- Must not be "Default" May not contain spaces Example: 'mysecuritygroup' cdbsgDBSecurityGroupName :: Lens' CreateDBSecurityGroup Text cdbsgDBSecurityGroupName = lens _cdbsgDBSecurityGroupName diff --git a/gen/Network/AWS/RDS/CreateDBSnapshot.hs b/gen/Network/AWS/RDS/CreateDBSnapshot.hs --- a/gen/Network/AWS/RDS/CreateDBSnapshot.hs +++ b/gen/Network/AWS/RDS/CreateDBSnapshot.hs @@ -73,18 +73,25 @@ } -- | The DB instance identifier. This is the unique key that identifies a DB --- instance. Constraints: Must contain from 1 to 63 alphanumeric characters --- or hyphens First character must be a letter Cannot end with a hyphen or --- contain two consecutive hyphens. +-- instance. +-- +-- Constraints: +-- +-- Must contain from 1 to 63 alphanumeric characters or hyphens First +-- character must be a letter Cannot end with a hyphen or contain two +-- consecutive hyphens cdbs1DBInstanceIdentifier :: Lens' CreateDBSnapshot Text cdbs1DBInstanceIdentifier = lens _cdbs1DBInstanceIdentifier (\s a -> s { _cdbs1DBInstanceIdentifier = a }) --- | The identifier for the DB snapshot. Constraints: Cannot be null, empty, --- or blank Must contain from 1 to 255 alphanumeric characters or hyphens --- First character must be a letter Cannot end with a hyphen or contain two --- consecutive hyphens Example: my-snapshot-id. +-- | The identifier for the DB snapshot. +-- +-- Constraints: +-- +-- Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric +-- characters or hyphens First character must be a letter Cannot end with a +-- hyphen or contain two consecutive hyphens Example: 'my-snapshot-id' cdbs1DBSnapshotIdentifier :: Lens' CreateDBSnapshot Text cdbs1DBSnapshotIdentifier = lens _cdbs1DBSnapshotIdentifier diff --git a/gen/Network/AWS/RDS/CreateDBSubnetGroup.hs b/gen/Network/AWS/RDS/CreateDBSubnetGroup.hs --- a/gen/Network/AWS/RDS/CreateDBSubnetGroup.hs +++ b/gen/Network/AWS/RDS/CreateDBSubnetGroup.hs @@ -85,8 +85,12 @@ (\s a -> s { _cdbsg1DBSubnetGroupDescription = a }) -- | The name for the DB subnet group. This value is stored as a lowercase --- string. Constraints: Must contain no more than 255 alphanumeric --- characters or hyphens. Must not be "Default". Example: mySubnetgroup. +-- string. +-- +-- Constraints: Must contain no more than 255 alphanumeric characters or +-- hyphens. Must not be "Default". +-- +-- Example: 'mySubnetgroup' cdbsg1DBSubnetGroupName :: Lens' CreateDBSubnetGroup Text cdbsg1DBSubnetGroupName = lens _cdbsg1DBSubnetGroupName (\s a -> s { _cdbsg1DBSubnetGroupName = a }) diff --git a/gen/Network/AWS/RDS/CreateEventSubscription.hs b/gen/Network/AWS/RDS/CreateEventSubscription.hs --- a/gen/Network/AWS/RDS/CreateEventSubscription.hs +++ b/gen/Network/AWS/RDS/CreateEventSubscription.hs @@ -20,24 +20,27 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Creates an RDS event notification subscription. This action requires a --- topic ARN (Amazon Resource Name) created by either the RDS console, the SNS +-- | Creates an RDS event notification subscription. This action requires a topic +-- ARN (Amazon Resource Name) created by either the RDS console, the SNS -- console, or the SNS API. To obtain an ARN with SNS, you must create a topic -- in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS --- console. You can specify the type of source (SourceType) you want to be --- notified of, provide a list of RDS sources (SourceIds) that triggers the --- events, and provide a list of event categories (EventCategories) for events --- you want to be notified of. For example, you can specify SourceType = --- db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = --- Availability, Backup. If you specify both the SourceType and SourceIds, --- such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you --- will be notified of all the db-instance events for the specified source. If --- you specify a SourceType but do not specify a SourceIdentifier, you will --- receive notice of the events for that source type for all your RDS sources. --- If you do not specify either the SourceType nor the SourceIdentifier, you --- will be notified of events generated from all RDS sources belonging to your --- customer account. +-- console. -- +-- You can specify the type of source (SourceType) you want to be notified of, +-- provide a list of RDS sources (SourceIds) that triggers the events, and +-- provide a list of event categories (EventCategories) for events you want to +-- be notified of. For example, you can specify SourceType = db-instance, +-- SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, +-- Backup. +-- +-- If you specify both the SourceType and SourceIds, such as SourceType = +-- db-instance and SourceIdentifier = myDBInstance1, you will be notified of all +-- the db-instance events for the specified source. If you specify a SourceType +-- but do not specify a SourceIdentifier, you will receive notice of the events +-- for that source type for all your RDS sources. If you do not specify either +-- the SourceType nor the SourceIdentifier, you will be notified of events +-- generated from all RDS sources belonging to your customer account. +-- -- module Network.AWS.RDS.CreateEventSubscription ( @@ -108,50 +111,54 @@ , _cesTags = mempty } --- | A Boolean value; set to true to activate the subscription, set to false --- to create the subscription but not active it. +-- | A Boolean value; set to true to activate the subscription, set to false to +-- create the subscription but not active it. cesEnabled :: Lens' CreateEventSubscription (Maybe Bool) cesEnabled = lens _cesEnabled (\s a -> s { _cesEnabled = a }) --- | A list of event categories for a SourceType that you want to subscribe --- to. You can see a list of the categories for a given SourceType in the --- Events topic in the Amazon RDS User Guide or by using the --- DescribeEventCategories action. +-- | A list of event categories for a SourceType that you want to subscribe to. +-- You can see a list of the categories for a given SourceType in the +-- topic in the Amazon RDS User Guide or by using the DescribeEventCategories +-- action. cesEventCategories :: Lens' CreateEventSubscription [Text] cesEventCategories = lens _cesEventCategories (\s a -> s { _cesEventCategories = a }) . _List -- | The Amazon Resource Name (ARN) of the SNS topic created for event --- notification. The ARN is created by Amazon SNS when you create a topic --- and subscribe to it. +-- notification. The ARN is created by Amazon SNS when you create a topic and +-- subscribe to it. cesSnsTopicArn :: Lens' CreateEventSubscription Text cesSnsTopicArn = lens _cesSnsTopicArn (\s a -> s { _cesSnsTopicArn = a }) -- | The list of identifiers of the event sources for which events will be --- returned. If not specified, then all sources are included in the --- response. An identifier must begin with a letter and must contain only --- ASCII letters, digits, and hyphens; it cannot end with a hyphen or --- contain two consecutive hyphens. Constraints: If SourceIds are supplied, --- SourceType must also be provided. If the source type is a DB instance, --- then a DBInstanceIdentifier must be supplied. If the source type is a DB --- security group, a DBSecurityGroupName must be supplied. If the source --- type is a DB parameter group, a DBParameterGroupName must be supplied. If --- the source type is a DB snapshot, a DBSnapshotIdentifier must be --- supplied. +-- returned. If not specified, then all sources are included in the response. An +-- identifier must begin with a letter and must contain only ASCII letters, +-- digits, and hyphens; it cannot end with a hyphen or contain two consecutive +-- hyphens. +-- +-- Constraints: +-- +-- If SourceIds are supplied, SourceType must also be provided. If the source +-- type is a DB instance, then a 'DBInstanceIdentifier' must be supplied. If the +-- source type is a DB security group, a 'DBSecurityGroupName' must be supplied. If the source type is a DB parameter group, a +-- 'DBParameterGroupName' must be supplied. If the source type is a DB snapshot, a 'DBSnapshotIdentifier' must be supplied. cesSourceIds :: Lens' CreateEventSubscription [Text] cesSourceIds = lens _cesSourceIds (\s a -> s { _cesSourceIds = a }) . _List --- | The type of source that will be generating the events. For example, if --- you want to be notified of events generated by a DB instance, you would --- set this parameter to db-instance. if this value is not specified, all --- events are returned. Valid values: db-instance | db-parameter-group | --- db-security-group | db-snapshot. +-- | The type of source that will be generating the events. For example, if you +-- want to be notified of events generated by a DB instance, you would set this +-- parameter to db-instance. if this value is not specified, all events are +-- returned. +-- +-- Valid values: db-instance | db-parameter-group | db-security-group | +-- db-snapshot cesSourceType :: Lens' CreateEventSubscription (Maybe Text) cesSourceType = lens _cesSourceType (\s a -> s { _cesSourceType = a }) --- | The name of the subscription. Constraints: The name must be less than 255 --- characters. +-- | The name of the subscription. +-- +-- Constraints: The name must be less than 255 characters. cesSubscriptionName :: Lens' CreateEventSubscription Text cesSubscriptionName = lens _cesSubscriptionName (\s a -> s { _cesSubscriptionName = a }) diff --git a/gen/Network/AWS/RDS/CreateOptionGroup.hs b/gen/Network/AWS/RDS/CreateOptionGroup.hs --- a/gen/Network/AWS/RDS/CreateOptionGroup.hs +++ b/gen/Network/AWS/RDS/CreateOptionGroup.hs @@ -84,13 +84,13 @@ , _cogTags = mempty } --- | Specifies the name of the engine that this option group should be --- associated with. +-- | Specifies the name of the engine that this option group should be associated +-- with. cogEngineName :: Lens' CreateOptionGroup Text cogEngineName = lens _cogEngineName (\s a -> s { _cogEngineName = a }) --- | Specifies the major version of the engine that this option group should --- be associated with. +-- | Specifies the major version of the engine that this option group should be +-- associated with. cogMajorEngineVersion :: Lens' CreateOptionGroup Text cogMajorEngineVersion = lens _cogMajorEngineVersion (\s a -> s { _cogMajorEngineVersion = a }) @@ -101,10 +101,13 @@ lens _cogOptionGroupDescription (\s a -> s { _cogOptionGroupDescription = a }) --- | Specifies the name of the option group to be created. Constraints: Must --- be 1 to 255 alphanumeric characters or hyphens First character must be a --- letter Cannot end with a hyphen or contain two consecutive hyphens --- Example: myoptiongroup. +-- | Specifies the name of the option group to be created. +-- +-- Constraints: +-- +-- Must be 1 to 255 alphanumeric characters or hyphens First character must be +-- a letter Cannot end with a hyphen or contain two consecutive hyphens Example: +-- 'myoptiongroup' cogOptionGroupName :: Lens' CreateOptionGroup Text cogOptionGroupName = lens _cogOptionGroupName (\s a -> s { _cogOptionGroupName = a }) diff --git a/gen/Network/AWS/RDS/DeleteDBInstance.hs b/gen/Network/AWS/RDS/DeleteDBInstance.hs --- a/gen/Network/AWS/RDS/DeleteDBInstance.hs +++ b/gen/Network/AWS/RDS/DeleteDBInstance.hs @@ -24,11 +24,13 @@ -- successful response from the web service indicates the request was received -- correctly. When you delete a DB instance, all automated backups for that -- instance are deleted and cannot be recovered. Manual DB snapshots of the DB --- instance to be deleted are not deleted. If a final DB snapshot is requested --- the status of the RDS instance will be "deleting" until the DB snapshot is --- created. The API action DescribeDBInstance is used to monitor the status of --- this operation. The action cannot be canceled or reverted once submitted. +-- instance to be deleted are not deleted. -- +-- If a final DB snapshot is requested the status of the RDS instance will be +-- "deleting" until the DB snapshot is created. The API action 'DescribeDBInstance' +-- is used to monitor the status of this operation. The action cannot be +-- canceled or reverted once submitted. +-- -- module Network.AWS.RDS.DeleteDBInstance ( @@ -78,29 +80,38 @@ , _ddbiFinalDBSnapshotIdentifier = Nothing } --- | The DB instance identifier for the DB instance to be deleted. This --- parameter isn't case sensitive. Constraints: Must contain from 1 to 63 --- alphanumeric characters or hyphens First character must be a letter --- Cannot end with a hyphen or contain two consecutive hyphens. +-- | The DB instance identifier for the DB instance to be deleted. This parameter +-- isn't case sensitive. +-- +-- Constraints: +-- +-- Must contain from 1 to 63 alphanumeric characters or hyphens First +-- character must be a letter Cannot end with a hyphen or contain two +-- consecutive hyphens ddbiDBInstanceIdentifier :: Lens' DeleteDBInstance Text ddbiDBInstanceIdentifier = lens _ddbiDBInstanceIdentifier (\s a -> s { _ddbiDBInstanceIdentifier = a }) -- | The DBSnapshotIdentifier of the new DBSnapshot created when --- SkipFinalSnapshot is set to false. Constraints: Must be 1 to 255 --- alphanumeric characters First character must be a letter Cannot end with --- a hyphen or contain two consecutive hyphens Cannot be specified when --- deleting a read replica. +-- SkipFinalSnapshot is set to 'false'. +-- +-- Constraints: +-- +-- Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens +-- Cannot be specified when deleting a read replica. ddbiFinalDBSnapshotIdentifier :: Lens' DeleteDBInstance (Maybe Text) ddbiFinalDBSnapshotIdentifier = lens _ddbiFinalDBSnapshotIdentifier (\s a -> s { _ddbiFinalDBSnapshotIdentifier = a }) --- | Determines whether a final DB snapshot is created before the DB instance --- is deleted. If true is specified, no DBSnapshot is created. If false is +-- | Determines whether a final DB snapshot is created before the DB instance is +-- deleted. If 'true' is specified, no DBSnapshot is created. If 'false' is -- specified, a DB snapshot is created before the DB instance is deleted. --- Specify true when deleting a read replica. Default: false. +-- +-- Specify 'true' when deleting a read replica. +-- +-- Default: 'false' ddbiSkipFinalSnapshot :: Lens' DeleteDBInstance (Maybe Bool) ddbiSkipFinalSnapshot = lens _ddbiSkipFinalSnapshot (\s a -> s { _ddbiSkipFinalSnapshot = a }) diff --git a/gen/Network/AWS/RDS/DeleteDBParameterGroup.hs b/gen/Network/AWS/RDS/DeleteDBParameterGroup.hs --- a/gen/Network/AWS/RDS/DeleteDBParameterGroup.hs +++ b/gen/Network/AWS/RDS/DeleteDBParameterGroup.hs @@ -60,9 +60,12 @@ { _ddbpg1DBParameterGroupName = p1 } --- | The name of the DB parameter group. Constraints: Must be the name of an --- existing DB parameter group You cannot delete a default DB parameter --- group Cannot be associated with any DB instances. +-- | The name of the DB parameter group. +-- +-- Constraints: +-- +-- Must be the name of an existing DB parameter group You cannot delete a +-- default DB parameter group Cannot be associated with any DB instances ddbpg1DBParameterGroupName :: Lens' DeleteDBParameterGroup Text ddbpg1DBParameterGroupName = lens _ddbpg1DBParameterGroupName diff --git a/gen/Network/AWS/RDS/DeleteDBSecurityGroup.hs b/gen/Network/AWS/RDS/DeleteDBSecurityGroup.hs --- a/gen/Network/AWS/RDS/DeleteDBSecurityGroup.hs +++ b/gen/Network/AWS/RDS/DeleteDBSecurityGroup.hs @@ -59,10 +59,12 @@ { _ddbsgDBSecurityGroupName = p1 } --- | The name of the DB security group to delete. Constraints: Must be 1 to --- 255 alphanumeric characters First character must be a letter Cannot end --- with a hyphen or contain two consecutive hyphens Must not be "Default" --- May not contain spaces. +-- | The name of the DB security group to delete. +-- +-- Constraints: +-- +-- Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens +-- Must not be "Default" May not contain spaces ddbsgDBSecurityGroupName :: Lens' DeleteDBSecurityGroup Text ddbsgDBSecurityGroupName = lens _ddbsgDBSecurityGroupName diff --git a/gen/Network/AWS/RDS/DeleteDBSnapshot.hs b/gen/Network/AWS/RDS/DeleteDBSnapshot.hs --- a/gen/Network/AWS/RDS/DeleteDBSnapshot.hs +++ b/gen/Network/AWS/RDS/DeleteDBSnapshot.hs @@ -20,8 +20,8 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Deletes a DBSnapshot. If the snapshot is being copied, the copy operation --- is terminated. +-- | Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is +-- terminated. -- -- module Network.AWS.RDS.DeleteDBSnapshot @@ -62,8 +62,10 @@ { _ddbs1DBSnapshotIdentifier = p1 } --- | The DBSnapshot identifier. Constraints: Must be the name of an existing --- DB snapshot in the available state. +-- | The DBSnapshot identifier. +-- +-- Constraints: Must be the name of an existing DB snapshot in the 'available' +-- state. ddbs1DBSnapshotIdentifier :: Lens' DeleteDBSnapshot Text ddbs1DBSnapshotIdentifier = lens _ddbs1DBSnapshotIdentifier diff --git a/gen/Network/AWS/RDS/DeleteDBSubnetGroup.hs b/gen/Network/AWS/RDS/DeleteDBSubnetGroup.hs --- a/gen/Network/AWS/RDS/DeleteDBSubnetGroup.hs +++ b/gen/Network/AWS/RDS/DeleteDBSubnetGroup.hs @@ -59,9 +59,12 @@ { _ddbsg1DBSubnetGroupName = p1 } --- | The name of the database subnet group to delete. Constraints: Must be 1 --- to 255 alphanumeric characters First character must be a letter Cannot --- end with a hyphen or contain two consecutive hyphens. +-- | The name of the database subnet group to delete. +-- +-- Constraints: +-- +-- Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens +-- ddbsg1DBSubnetGroupName :: Lens' DeleteDBSubnetGroup Text ddbsg1DBSubnetGroupName = lens _ddbsg1DBSubnetGroupName (\s a -> s { _ddbsg1DBSubnetGroupName = a }) diff --git a/gen/Network/AWS/RDS/DescribeDBEngineVersions.hs b/gen/Network/AWS/RDS/DescribeDBEngineVersions.hs --- a/gen/Network/AWS/RDS/DescribeDBEngineVersions.hs +++ b/gen/Network/AWS/RDS/DescribeDBEngineVersions.hs @@ -97,9 +97,11 @@ } -- | The name of a specific DB parameter group family to return details for. --- Constraints: Must be 1 to 255 alphanumeric characters First character --- must be a letter Cannot end with a hyphen or contain two consecutive --- hyphens. +-- +-- Constraints: +-- +-- Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens +-- ddbevDBParameterGroupFamily :: Lens' DescribeDBEngineVersions (Maybe Text) ddbevDBParameterGroupFamily = lens _ddbevDBParameterGroupFamily @@ -114,7 +116,9 @@ ddbevEngine :: Lens' DescribeDBEngineVersions (Maybe Text) ddbevEngine = lens _ddbevEngine (\s a -> s { _ddbevEngine = a }) --- | The database engine version to return. Example: 5.1.49. +-- | The database engine version to return. +-- +-- Example: '5.1.49' ddbevEngineVersion :: Lens' DescribeDBEngineVersions (Maybe Text) ddbevEngineVersion = lens _ddbevEngineVersion (\s a -> s { _ddbevEngineVersion = a }) @@ -124,23 +128,25 @@ ddbevFilters = lens _ddbevFilters (\s a -> s { _ddbevFilters = a }) . _List -- | If this parameter is specified, and if the requested engine supports the --- CharacterSetName parameter for CreateDBInstance, the response includes a --- list of supported character sets for each engine version. +-- CharacterSetName parameter for CreateDBInstance, the response includes a list +-- of supported character sets for each engine version. ddbevListSupportedCharacterSets :: Lens' DescribeDBEngineVersions (Maybe Bool) ddbevListSupportedCharacterSets = lens _ddbevListSupportedCharacterSets (\s a -> s { _ddbevListSupportedCharacterSets = a }) -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. ddbevMarker :: Lens' DescribeDBEngineVersions (Maybe Text) ddbevMarker = lens _ddbevMarker (\s a -> s { _ddbevMarker = a }) --- | The maximum number of records to include in the response. If more than --- the MaxRecords value is available, a pagination token called a marker is --- included in the response so that the following results can be retrieved. --- Default: 100 Constraints: minimum 20, maximum 100. +-- | The maximum number of records to include in the response. If more than the 'MaxRecords' value is available, a pagination token called a marker is included in the +-- response so that the following results can be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 ddbevMaxRecords :: Lens' DescribeDBEngineVersions (Maybe Int) ddbevMaxRecords = lens _ddbevMaxRecords (\s a -> s { _ddbevMaxRecords = a }) @@ -163,15 +169,15 @@ , _ddbevrDBEngineVersions = mempty } --- | A list of DBEngineVersion elements. +-- | A list of 'DBEngineVersion' elements. ddbevrDBEngineVersions :: Lens' DescribeDBEngineVersionsResponse [DBEngineVersion] ddbevrDBEngineVersions = lens _ddbevrDBEngineVersions (\s a -> s { _ddbevrDBEngineVersions = a }) . _List -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. ddbevrMarker :: Lens' DescribeDBEngineVersionsResponse (Maybe Text) ddbevrMarker = lens _ddbevrMarker (\s a -> s { _ddbevrMarker = a }) diff --git a/gen/Network/AWS/RDS/DescribeDBInstances.hs b/gen/Network/AWS/RDS/DescribeDBInstances.hs --- a/gen/Network/AWS/RDS/DescribeDBInstances.hs +++ b/gen/Network/AWS/RDS/DescribeDBInstances.hs @@ -78,10 +78,14 @@ } -- | The user-supplied instance identifier. If this parameter is specified, --- information from only the specific DB instance is returned. This --- parameter isn't case sensitive. Constraints: Must contain from 1 to 63 --- alphanumeric characters or hyphens First character must be a letter --- Cannot end with a hyphen or contain two consecutive hyphens. +-- information from only the specific DB instance is returned. This parameter +-- isn't case sensitive. +-- +-- Constraints: +-- +-- Must contain from 1 to 63 alphanumeric characters or hyphens First +-- character must be a letter Cannot end with a hyphen or contain two +-- consecutive hyphens ddbi1DBInstanceIdentifier :: Lens' DescribeDBInstances (Maybe Text) ddbi1DBInstanceIdentifier = lens _ddbi1DBInstanceIdentifier @@ -92,15 +96,18 @@ ddbi1Filters = lens _ddbi1Filters (\s a -> s { _ddbi1Filters = a }) . _List -- | An optional pagination token provided by a previous DescribeDBInstances --- request. If this parameter is specified, the response includes only --- records beyond the marker, up to the value specified by MaxRecords . +-- request. If this parameter is specified, the response includes only records +-- beyond the marker, up to the value specified by 'MaxRecords' . ddbi1Marker :: Lens' DescribeDBInstances (Maybe Text) ddbi1Marker = lens _ddbi1Marker (\s a -> s { _ddbi1Marker = a }) -- | The maximum number of records to include in the response. If more records --- exist than the specified MaxRecords value, a pagination token called a --- marker is included in the response so that the remaining results may be --- retrieved. Default: 100 Constraints: minimum 20, maximum 100. +-- exist than the specified 'MaxRecords' value, a pagination token called a marker +-- is included in the response so that the remaining results may be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 ddbi1MaxRecords :: Lens' DescribeDBInstances (Maybe Int) ddbi1MaxRecords = lens _ddbi1MaxRecords (\s a -> s { _ddbi1MaxRecords = a }) @@ -123,13 +130,13 @@ , _ddbirDBInstances = mempty } --- | A list of DBInstance instances. +-- | A list of 'DBInstance' instances. ddbirDBInstances :: Lens' DescribeDBInstancesResponse [DBInstance] ddbirDBInstances = lens _ddbirDBInstances (\s a -> s { _ddbirDBInstances = a }) . _List -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords . +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords' . ddbirMarker :: Lens' DescribeDBInstancesResponse (Maybe Text) ddbirMarker = lens _ddbirMarker (\s a -> s { _ddbirMarker = a }) diff --git a/gen/Network/AWS/RDS/DescribeDBLogFiles.hs b/gen/Network/AWS/RDS/DescribeDBLogFiles.hs --- a/gen/Network/AWS/RDS/DescribeDBLogFiles.hs +++ b/gen/Network/AWS/RDS/DescribeDBLogFiles.hs @@ -93,16 +93,20 @@ } -- | The customer-assigned name of the DB instance that contains the log files --- you want to list. Constraints: Must contain from 1 to 63 alphanumeric --- characters or hyphens First character must be a letter Cannot end with a --- hyphen or contain two consecutive hyphens. +-- you want to list. +-- +-- Constraints: +-- +-- Must contain from 1 to 63 alphanumeric characters or hyphens First +-- character must be a letter Cannot end with a hyphen or contain two +-- consecutive hyphens ddblfDBInstanceIdentifier :: Lens' DescribeDBLogFiles Text ddblfDBInstanceIdentifier = lens _ddblfDBInstanceIdentifier (\s a -> s { _ddblfDBInstanceIdentifier = a }) --- | Filters the available log files for files written since the specified --- date, in POSIX timestamp format. +-- | Filters the available log files for files written since the specified date, +-- in POSIX timestamp format. ddblfFileLastWritten :: Lens' DescribeDBLogFiles (Maybe Integer) ddblfFileLastWritten = lens _ddblfFileLastWritten (\s a -> s { _ddblfFileLastWritten = a }) @@ -121,16 +125,15 @@ ddblfFilters :: Lens' DescribeDBLogFiles [Filter] ddblfFilters = lens _ddblfFilters (\s a -> s { _ddblfFilters = a }) . _List --- | The pagination token provided in the previous request. If this parameter --- is specified the response includes only records beyond the marker, up to +-- | The pagination token provided in the previous request. If this parameter is +-- specified the response includes only records beyond the marker, up to -- MaxRecords. ddblfMarker :: Lens' DescribeDBLogFiles (Maybe Text) ddblfMarker = lens _ddblfMarker (\s a -> s { _ddblfMarker = a }) -- | The maximum number of records to include in the response. If more records --- exist than the specified MaxRecords value, a pagination token called a --- marker is included in the response so that the remaining results can be --- retrieved. +-- exist than the specified MaxRecords value, a pagination token called a marker +-- is included in the response so that the remaining results can be retrieved. ddblfMaxRecords :: Lens' DescribeDBLogFiles (Maybe Int) ddblfMaxRecords = lens _ddblfMaxRecords (\s a -> s { _ddblfMaxRecords = a }) diff --git a/gen/Network/AWS/RDS/DescribeDBParameterGroups.hs b/gen/Network/AWS/RDS/DescribeDBParameterGroups.hs --- a/gen/Network/AWS/RDS/DescribeDBParameterGroups.hs +++ b/gen/Network/AWS/RDS/DescribeDBParameterGroups.hs @@ -20,9 +20,9 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName --- is specified, the list will contain only the description of the specified --- DB parameter group. +-- | Returns a list of 'DBParameterGroup' descriptions. If a 'DBParameterGroupName' +-- is specified, the list will contain only the description of the specified DB +-- parameter group. -- -- module Network.AWS.RDS.DescribeDBParameterGroups @@ -79,9 +79,11 @@ } -- | The name of a specific DB parameter group to return details for. --- Constraints: Must be 1 to 255 alphanumeric characters First character --- must be a letter Cannot end with a hyphen or contain two consecutive --- hyphens. +-- +-- Constraints: +-- +-- Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens +-- ddbpgDBParameterGroupName :: Lens' DescribeDBParameterGroups (Maybe Text) ddbpgDBParameterGroupName = lens _ddbpgDBParameterGroupName @@ -91,17 +93,19 @@ ddbpgFilters :: Lens' DescribeDBParameterGroups [Filter] ddbpgFilters = lens _ddbpgFilters (\s a -> s { _ddbpgFilters = a }) . _List --- | An optional pagination token provided by a previous --- DescribeDBParameterGroups request. If this parameter is specified, the --- response includes only records beyond the marker, up to the value --- specified by MaxRecords. +-- | An optional pagination token provided by a previous 'DescribeDBParameterGroups' +-- request. If this parameter is specified, the response includes only records +-- beyond the marker, up to the value specified by 'MaxRecords'. ddbpgMarker :: Lens' DescribeDBParameterGroups (Maybe Text) ddbpgMarker = lens _ddbpgMarker (\s a -> s { _ddbpgMarker = a }) -- | The maximum number of records to include in the response. If more records --- exist than the specified MaxRecords value, a pagination token called a --- marker is included in the response so that the remaining results may be --- retrieved. Default: 100 Constraints: minimum 20, maximum 100. +-- exist than the specified 'MaxRecords' value, a pagination token called a marker +-- is included in the response so that the remaining results may be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 ddbpgMaxRecords :: Lens' DescribeDBParameterGroups (Maybe Int) ddbpgMaxRecords = lens _ddbpgMaxRecords (\s a -> s { _ddbpgMaxRecords = a }) @@ -124,15 +128,15 @@ , _ddbpgrDBParameterGroups = mempty } --- | A list of DBParameterGroup instances. +-- | A list of 'DBParameterGroup' instances. ddbpgrDBParameterGroups :: Lens' DescribeDBParameterGroupsResponse [DBParameterGroup] ddbpgrDBParameterGroups = lens _ddbpgrDBParameterGroups (\s a -> s { _ddbpgrDBParameterGroups = a }) . _List -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. ddbpgrMarker :: Lens' DescribeDBParameterGroupsResponse (Maybe Text) ddbpgrMarker = lens _ddbpgrMarker (\s a -> s { _ddbpgrMarker = a }) diff --git a/gen/Network/AWS/RDS/DescribeDBParameters.hs b/gen/Network/AWS/RDS/DescribeDBParameters.hs --- a/gen/Network/AWS/RDS/DescribeDBParameters.hs +++ b/gen/Network/AWS/RDS/DescribeDBParameters.hs @@ -83,9 +83,11 @@ } -- | The name of a specific DB parameter group to return details for. --- Constraints: Must be 1 to 255 alphanumeric characters First character --- must be a letter Cannot end with a hyphen or contain two consecutive --- hyphens. +-- +-- Constraints: +-- +-- Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens +-- ddbpDBParameterGroupName :: Lens' DescribeDBParameters Text ddbpDBParameterGroupName = lens _ddbpDBParameterGroupName @@ -95,21 +97,27 @@ ddbpFilters :: Lens' DescribeDBParameters [Filter] ddbpFilters = lens _ddbpFilters (\s a -> s { _ddbpFilters = a }) . _List --- | An optional pagination token provided by a previous DescribeDBParameters --- request. If this parameter is specified, the response includes only --- records beyond the marker, up to the value specified by MaxRecords. +-- | An optional pagination token provided by a previous 'DescribeDBParameters' +-- request. If this parameter is specified, the response includes only records +-- beyond the marker, up to the value specified by 'MaxRecords'. ddbpMarker :: Lens' DescribeDBParameters (Maybe Text) ddbpMarker = lens _ddbpMarker (\s a -> s { _ddbpMarker = a }) -- | The maximum number of records to include in the response. If more records --- exist than the specified MaxRecords value, a pagination token called a --- marker is included in the response so that the remaining results may be --- retrieved. Default: 100 Constraints: minimum 20, maximum 100. +-- exist than the specified 'MaxRecords' value, a pagination token called a marker +-- is included in the response so that the remaining results may be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 ddbpMaxRecords :: Lens' DescribeDBParameters (Maybe Int) ddbpMaxRecords = lens _ddbpMaxRecords (\s a -> s { _ddbpMaxRecords = a }) --- | The parameter types to return. Default: All parameter types returned --- Valid Values: user | system | engine-default. +-- | The parameter types to return. +-- +-- Default: All parameter types returned +-- +-- Valid Values: 'user | system | engine-default' ddbpSource :: Lens' DescribeDBParameters (Maybe Text) ddbpSource = lens _ddbpSource (\s a -> s { _ddbpSource = a }) @@ -133,12 +141,12 @@ } -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. ddbprMarker :: Lens' DescribeDBParametersResponse (Maybe Text) ddbprMarker = lens _ddbprMarker (\s a -> s { _ddbprMarker = a }) --- | A list of Parameter values. +-- | A list of 'Parameter' values. ddbprParameters :: Lens' DescribeDBParametersResponse [Parameter] ddbprParameters = lens _ddbprParameters (\s a -> s { _ddbprParameters = a }) . _List diff --git a/gen/Network/AWS/RDS/DescribeDBSecurityGroups.hs b/gen/Network/AWS/RDS/DescribeDBSecurityGroups.hs --- a/gen/Network/AWS/RDS/DescribeDBSecurityGroups.hs +++ b/gen/Network/AWS/RDS/DescribeDBSecurityGroups.hs @@ -20,7 +20,7 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is +-- | Returns a list of 'DBSecurityGroup' descriptions. If a 'DBSecurityGroupName' is -- specified, the list will contain only the descriptions of the specified DB -- security group. -- @@ -88,17 +88,19 @@ ddbsg1Filters :: Lens' DescribeDBSecurityGroups [Filter] ddbsg1Filters = lens _ddbsg1Filters (\s a -> s { _ddbsg1Filters = a }) . _List --- | An optional pagination token provided by a previous --- DescribeDBSecurityGroups request. If this parameter is specified, the --- response includes only records beyond the marker, up to the value --- specified by MaxRecords. +-- | An optional pagination token provided by a previous DescribeDBSecurityGroups +-- request. If this parameter is specified, the response includes only records +-- beyond the marker, up to the value specified by 'MaxRecords'. ddbsg1Marker :: Lens' DescribeDBSecurityGroups (Maybe Text) ddbsg1Marker = lens _ddbsg1Marker (\s a -> s { _ddbsg1Marker = a }) -- | The maximum number of records to include in the response. If more records --- exist than the specified MaxRecords value, a pagination token called a --- marker is included in the response so that the remaining results may be --- retrieved. Default: 100 Constraints: minimum 20, maximum 100. +-- exist than the specified 'MaxRecords' value, a pagination token called a marker +-- is included in the response so that the remaining results may be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 ddbsg1MaxRecords :: Lens' DescribeDBSecurityGroups (Maybe Int) ddbsg1MaxRecords = lens _ddbsg1MaxRecords (\s a -> s { _ddbsg1MaxRecords = a }) @@ -121,15 +123,15 @@ , _ddbsgr1DBSecurityGroups = mempty } --- | A list of DBSecurityGroup instances. +-- | A list of 'DBSecurityGroup' instances. ddbsgr1DBSecurityGroups :: Lens' DescribeDBSecurityGroupsResponse [DBSecurityGroup] ddbsgr1DBSecurityGroups = lens _ddbsgr1DBSecurityGroups (\s a -> s { _ddbsgr1DBSecurityGroups = a }) . _List -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. ddbsgr1Marker :: Lens' DescribeDBSecurityGroupsResponse (Maybe Text) ddbsgr1Marker = lens _ddbsgr1Marker (\s a -> s { _ddbsgr1Marker = a }) diff --git a/gen/Network/AWS/RDS/DescribeDBSnapshots.hs b/gen/Network/AWS/RDS/DescribeDBSnapshots.hs --- a/gen/Network/AWS/RDS/DescribeDBSnapshots.hs +++ b/gen/Network/AWS/RDS/DescribeDBSnapshots.hs @@ -86,22 +86,28 @@ , _ddbsMarker = Nothing } --- | A DB instance identifier to retrieve the list of DB snapshots for. Cannot --- be used in conjunction with DBSnapshotIdentifier. This parameter is not --- case sensitive. Constraints: Must contain from 1 to 63 alphanumeric --- characters or hyphens First character must be a letter Cannot end with a --- hyphen or contain two consecutive hyphens. +-- | A DB instance identifier to retrieve the list of DB snapshots for. Cannot be +-- used in conjunction with 'DBSnapshotIdentifier'. This parameter is not case +-- sensitive. +-- +-- Constraints: +-- +-- Must contain from 1 to 63 alphanumeric characters or hyphens First +-- character must be a letter Cannot end with a hyphen or contain two +-- consecutive hyphens ddbsDBInstanceIdentifier :: Lens' DescribeDBSnapshots (Maybe Text) ddbsDBInstanceIdentifier = lens _ddbsDBInstanceIdentifier (\s a -> s { _ddbsDBInstanceIdentifier = a }) --- | A specific DB snapshot identifier to describe. Cannot be used in --- conjunction with DBInstanceIdentifier. This value is stored as a --- lowercase string. Constraints: Must be 1 to 255 alphanumeric characters --- First character must be a letter Cannot end with a hyphen or contain two --- consecutive hyphens If this is the identifier of an automated snapshot, --- the SnapshotType parameter must also be specified. +-- | A specific DB snapshot identifier to describe. Cannot be used in conjunction +-- with 'DBInstanceIdentifier'. This value is stored as a lowercase string. +-- +-- Constraints: +-- +-- Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens +-- If this is the identifier of an automated snapshot, the 'SnapshotType' +-- parameter must also be specified. ddbsDBSnapshotIdentifier :: Lens' DescribeDBSnapshots (Maybe Text) ddbsDBSnapshotIdentifier = lens _ddbsDBSnapshotIdentifier @@ -111,22 +117,25 @@ ddbsFilters :: Lens' DescribeDBSnapshots [Filter] ddbsFilters = lens _ddbsFilters (\s a -> s { _ddbsFilters = a }) . _List --- | An optional pagination token provided by a previous DescribeDBSnapshots --- request. If this parameter is specified, the response includes only --- records beyond the marker, up to the value specified by MaxRecords. +-- | An optional pagination token provided by a previous 'DescribeDBSnapshots' +-- request. If this parameter is specified, the response includes only records +-- beyond the marker, up to the value specified by 'MaxRecords'. ddbsMarker :: Lens' DescribeDBSnapshots (Maybe Text) ddbsMarker = lens _ddbsMarker (\s a -> s { _ddbsMarker = a }) -- | The maximum number of records to include in the response. If more records --- exist than the specified MaxRecords value, a pagination token called a --- marker is included in the response so that the remaining results may be --- retrieved. Default: 100 Constraints: minimum 20, maximum 100. +-- exist than the specified 'MaxRecords' value, a pagination token called a marker +-- is included in the response so that the remaining results may be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 ddbsMaxRecords :: Lens' DescribeDBSnapshots (Maybe Int) ddbsMaxRecords = lens _ddbsMaxRecords (\s a -> s { _ddbsMaxRecords = a }) -- | The type of snapshots that will be returned. Values can be "automated" or --- "manual." If not specified, the returned results will include all --- snapshots types. +-- "manual." If not specified, the returned results will include all snapshots +-- types. ddbsSnapshotType :: Lens' DescribeDBSnapshots (Maybe Text) ddbsSnapshotType = lens _ddbsSnapshotType (\s a -> s { _ddbsSnapshotType = a }) @@ -149,13 +158,13 @@ , _ddbsrDBSnapshots = mempty } --- | A list of DBSnapshot instances. +-- | A list of 'DBSnapshot' instances. ddbsrDBSnapshots :: Lens' DescribeDBSnapshotsResponse [DBSnapshot] ddbsrDBSnapshots = lens _ddbsrDBSnapshots (\s a -> s { _ddbsrDBSnapshots = a }) . _List -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. ddbsrMarker :: Lens' DescribeDBSnapshotsResponse (Maybe Text) ddbsrMarker = lens _ddbsrMarker (\s a -> s { _ddbsrMarker = a }) diff --git a/gen/Network/AWS/RDS/DescribeDBSubnetGroups.hs b/gen/Network/AWS/RDS/DescribeDBSubnetGroups.hs --- a/gen/Network/AWS/RDS/DescribeDBSubnetGroups.hs +++ b/gen/Network/AWS/RDS/DescribeDBSubnetGroups.hs @@ -22,9 +22,10 @@ -- | Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is -- specified, the list will contain only the descriptions of the specified --- DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia --- Tutorial. +-- DBSubnetGroup. -- +-- For an overview of CIDR ranges, go to the . +-- -- module Network.AWS.RDS.DescribeDBSubnetGroups ( @@ -88,17 +89,19 @@ ddbsgFilters :: Lens' DescribeDBSubnetGroups [Filter] ddbsgFilters = lens _ddbsgFilters (\s a -> s { _ddbsgFilters = a }) . _List --- | An optional pagination token provided by a previous --- DescribeDBSubnetGroups request. If this parameter is specified, the --- response includes only records beyond the marker, up to the value --- specified by MaxRecords. +-- | An optional pagination token provided by a previous DescribeDBSubnetGroups +-- request. If this parameter is specified, the response includes only records +-- beyond the marker, up to the value specified by 'MaxRecords'. ddbsgMarker :: Lens' DescribeDBSubnetGroups (Maybe Text) ddbsgMarker = lens _ddbsgMarker (\s a -> s { _ddbsgMarker = a }) -- | The maximum number of records to include in the response. If more records --- exist than the specified MaxRecords value, a pagination token called a --- marker is included in the response so that the remaining results may be --- retrieved. Default: 100 Constraints: minimum 20, maximum 100. +-- exist than the specified 'MaxRecords' value, a pagination token called a marker +-- is included in the response so that the remaining results may be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 ddbsgMaxRecords :: Lens' DescribeDBSubnetGroups (Maybe Int) ddbsgMaxRecords = lens _ddbsgMaxRecords (\s a -> s { _ddbsgMaxRecords = a }) @@ -121,15 +124,15 @@ , _ddbsgrDBSubnetGroups = mempty } --- | A list of DBSubnetGroup instances. +-- | A list of 'DBSubnetGroup' instances. ddbsgrDBSubnetGroups :: Lens' DescribeDBSubnetGroupsResponse [DBSubnetGroup] ddbsgrDBSubnetGroups = lens _ddbsgrDBSubnetGroups (\s a -> s { _ddbsgrDBSubnetGroups = a }) . _List -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. ddbsgrMarker :: Lens' DescribeDBSubnetGroupsResponse (Maybe Text) ddbsgrMarker = lens _ddbsgrMarker (\s a -> s { _ddbsgrMarker = a }) diff --git a/gen/Network/AWS/RDS/DescribeEngineDefaultParameters.hs b/gen/Network/AWS/RDS/DescribeEngineDefaultParameters.hs --- a/gen/Network/AWS/RDS/DescribeEngineDefaultParameters.hs +++ b/gen/Network/AWS/RDS/DescribeEngineDefaultParameters.hs @@ -87,17 +87,18 @@ dedpFilters :: Lens' DescribeEngineDefaultParameters [Filter] dedpFilters = lens _dedpFilters (\s a -> s { _dedpFilters = a }) . _List --- | An optional pagination token provided by a previous --- DescribeEngineDefaultParameters request. If this parameter is specified, --- the response includes only records beyond the marker, up to the value --- specified by MaxRecords. +-- | An optional pagination token provided by a previous 'DescribeEngineDefaultParameters' request. If this parameter is specified, the response includes only records +-- beyond the marker, up to the value specified by 'MaxRecords'. dedpMarker :: Lens' DescribeEngineDefaultParameters (Maybe Text) dedpMarker = lens _dedpMarker (\s a -> s { _dedpMarker = a }) -- | The maximum number of records to include in the response. If more records --- exist than the specified MaxRecords value, a pagination token called a --- marker is included in the response so that the remaining results may be --- retrieved. Default: 100 Constraints: minimum 20, maximum 100. +-- exist than the specified 'MaxRecords' value, a pagination token called a marker +-- is included in the response so that the remaining results may be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 dedpMaxRecords :: Lens' DescribeEngineDefaultParameters (Maybe Int) dedpMaxRecords = lens _dedpMaxRecords (\s a -> s { _dedpMaxRecords = a }) diff --git a/gen/Network/AWS/RDS/DescribeEventCategories.hs b/gen/Network/AWS/RDS/DescribeEventCategories.hs --- a/gen/Network/AWS/RDS/DescribeEventCategories.hs +++ b/gen/Network/AWS/RDS/DescribeEventCategories.hs @@ -22,7 +22,7 @@ -- | Displays a list of categories for all event source types, or, if specified, -- for a specified source type. You can see a list of the event categories and --- source types in the Events topic in the Amazon RDS User Guide. +-- source types in the topic in the Amazon RDS User Guide. -- -- module Network.AWS.RDS.DescribeEventCategories @@ -71,8 +71,10 @@ decFilters :: Lens' DescribeEventCategories [Filter] decFilters = lens _decFilters (\s a -> s { _decFilters = a }) . _List --- | The type of source that will be generating the events. Valid values: --- db-instance | db-parameter-group | db-security-group | db-snapshot. +-- | The type of source that will be generating the events. +-- +-- Valid values: db-instance | db-parameter-group | db-security-group | +-- db-snapshot decSourceType :: Lens' DescribeEventCategories (Maybe Text) decSourceType = lens _decSourceType (\s a -> s { _decSourceType = a }) diff --git a/gen/Network/AWS/RDS/DescribeEventSubscriptions.hs b/gen/Network/AWS/RDS/DescribeEventSubscriptions.hs --- a/gen/Network/AWS/RDS/DescribeEventSubscriptions.hs +++ b/gen/Network/AWS/RDS/DescribeEventSubscriptions.hs @@ -22,9 +22,11 @@ -- | Lists all the subscription descriptions for a customer account. The -- description for a subscription includes SubscriptionName, SNSTopicARN, --- CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify --- a SubscriptionName, lists the description for that subscription. +-- CustomerID, SourceType, SourceID, CreationTime, and Status. -- +-- If you specify a SubscriptionName, lists the description for that +-- subscription. +-- -- module Network.AWS.RDS.DescribeEventSubscriptions ( @@ -84,16 +86,19 @@ des1Filters = lens _des1Filters (\s a -> s { _des1Filters = a }) . _List -- | An optional pagination token provided by a previous --- DescribeOrderableDBInstanceOptions request. If this parameter is --- specified, the response includes only records beyond the marker, up to --- the value specified by MaxRecords . +-- DescribeOrderableDBInstanceOptions request. If this parameter is specified, +-- the response includes only records beyond the marker, up to the value +-- specified by 'MaxRecords' . des1Marker :: Lens' DescribeEventSubscriptions (Maybe Text) des1Marker = lens _des1Marker (\s a -> s { _des1Marker = a }) -- | The maximum number of records to include in the response. If more records --- exist than the specified MaxRecords value, a pagination token called a --- marker is included in the response so that the remaining results can be --- retrieved. Default: 100 Constraints: minimum 20, maximum 100. +-- exist than the specified 'MaxRecords' value, a pagination token called a marker +-- is included in the response so that the remaining results can be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 des1MaxRecords :: Lens' DescribeEventSubscriptions (Maybe Int) des1MaxRecords = lens _des1MaxRecords (\s a -> s { _des1MaxRecords = a }) @@ -129,9 +134,9 @@ . _List -- | An optional pagination token provided by a previous --- DescribeOrderableDBInstanceOptions request. If this parameter is --- specified, the response includes only records beyond the marker, up to --- the value specified by MaxRecords. +-- DescribeOrderableDBInstanceOptions request. If this parameter is specified, +-- the response includes only records beyond the marker, up to the value +-- specified by 'MaxRecords'. desrMarker :: Lens' DescribeEventSubscriptionsResponse (Maybe Text) desrMarker = lens _desrMarker (\s a -> s { _desrMarker = a }) diff --git a/gen/Network/AWS/RDS/DescribeEvents.hs b/gen/Network/AWS/RDS/DescribeEvents.hs --- a/gen/Network/AWS/RDS/DescribeEvents.hs +++ b/gen/Network/AWS/RDS/DescribeEvents.hs @@ -21,10 +21,10 @@ -- Portability : non-portable (GHC extensions) -- | Returns events related to DB instances, DB security groups, DB snapshots, --- and DB parameter groups for the past 14 days. Events specific to a --- particular DB instance, DB security group, database snapshot, or DB --- parameter group can be obtained by providing the name as a parameter. By --- default, the past hour of events are returned. +-- and DB parameter groups for the past 14 days. Events specific to a particular +-- DB instance, DB security group, database snapshot, or DB parameter group can +-- be obtained by providing the name as a parameter. By default, the past hour +-- of events are returned. -- -- module Network.AWS.RDS.DescribeEvents @@ -60,14 +60,14 @@ data DescribeEvents = DescribeEvents { _deDuration :: Maybe Int - , _deEndTime :: Maybe RFC822 + , _deEndTime :: Maybe ISO8601 , _deEventCategories :: List "EventCategory" Text , _deFilters :: List "Filter" Filter , _deMarker :: Maybe Text , _deMaxRecords :: Maybe Int , _deSourceIdentifier :: Maybe Text , _deSourceType :: Maybe SourceType - , _deStartTime :: Maybe RFC822 + , _deStartTime :: Maybe ISO8601 } deriving (Eq, Show) -- | 'DescribeEvents' constructor. @@ -105,13 +105,16 @@ , _deMarker = Nothing } --- | The number of minutes to retrieve events for. Default: 60. +-- | The number of minutes to retrieve events for. +-- +-- Default: 60 deDuration :: Lens' DescribeEvents (Maybe Int) deDuration = lens _deDuration (\s a -> s { _deDuration = a }) --- | The end of the time interval for which to retrieve events, specified in --- ISO 8601 format. For more information about ISO 8601, go to the ISO8601 --- Wikipedia page. Example: 2009-07-08T18:00Z. +-- | The end of the time interval for which to retrieve events, specified in ISO +-- 8601 format. For more information about ISO 8601, go to the +-- +-- Example: 2009-07-08T18:00Z deEndTime :: Lens' DescribeEvents (Maybe UTCTime) deEndTime = lens _deEndTime (\s a -> s { _deEndTime = a }) . mapping _Time @@ -126,28 +129,33 @@ deFilters :: Lens' DescribeEvents [Filter] deFilters = lens _deFilters (\s a -> s { _deFilters = a }) . _List --- | An optional pagination token provided by a previous DescribeEvents --- request. If this parameter is specified, the response includes only --- records beyond the marker, up to the value specified by MaxRecords. +-- | An optional pagination token provided by a previous DescribeEvents request. +-- If this parameter is specified, the response includes only records beyond the +-- marker, up to the value specified by 'MaxRecords'. deMarker :: Lens' DescribeEvents (Maybe Text) deMarker = lens _deMarker (\s a -> s { _deMarker = a }) -- | The maximum number of records to include in the response. If more records --- exist than the specified MaxRecords value, a pagination token called a --- marker is included in the response so that the remaining results may be --- retrieved. Default: 100 Constraints: minimum 20, maximum 100. +-- exist than the specified 'MaxRecords' value, a pagination token called a marker +-- is included in the response so that the remaining results may be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 deMaxRecords :: Lens' DescribeEvents (Maybe Int) deMaxRecords = lens _deMaxRecords (\s a -> s { _deMaxRecords = a }) --- | The identifier of the event source for which events will be returned. If --- not specified, then all sources are included in the response. --- Constraints: If SourceIdentifier is supplied, SourceType must also be --- provided. If the source type is DBInstance, then a DBInstanceIdentifier --- must be supplied. If the source type is DBSecurityGroup, a --- DBSecurityGroupName must be supplied. If the source type is --- DBParameterGroup, a DBParameterGroupName must be supplied. If the source --- type is DBSnapshot, a DBSnapshotIdentifier must be supplied. Cannot end --- with a hyphen or contain two consecutive hyphens. +-- | The identifier of the event source for which events will be returned. If not +-- specified, then all sources are included in the response. +-- +-- Constraints: +-- +-- If SourceIdentifier is supplied, SourceType must also be provided. If the +-- source type is 'DBInstance', then a 'DBInstanceIdentifier' must be supplied. If +-- the source type is 'DBSecurityGroup', a 'DBSecurityGroupName' must be supplied. If the source type is +-- 'DBParameterGroup', a 'DBParameterGroupName' must be supplied. If the source type +-- is 'DBSnapshot', a 'DBSnapshotIdentifier' must be supplied. Cannot end with a +-- hyphen or contain two consecutive hyphens. deSourceIdentifier :: Lens' DescribeEvents (Maybe Text) deSourceIdentifier = lens _deSourceIdentifier (\s a -> s { _deSourceIdentifier = a }) @@ -157,9 +165,10 @@ deSourceType :: Lens' DescribeEvents (Maybe SourceType) deSourceType = lens _deSourceType (\s a -> s { _deSourceType = a }) --- | The beginning of the time interval to retrieve events for, specified in --- ISO 8601 format. For more information about ISO 8601, go to the ISO8601 --- Wikipedia page. Example: 2009-07-08T18:00Z. +-- | The beginning of the time interval to retrieve events for, specified in ISO +-- 8601 format. For more information about ISO 8601, go to the +-- +-- Example: 2009-07-08T18:00Z deStartTime :: Lens' DescribeEvents (Maybe UTCTime) deStartTime = lens _deStartTime (\s a -> s { _deStartTime = a }) . mapping _Time @@ -182,13 +191,13 @@ , _derEvents = mempty } --- | A list of Event instances. +-- | A list of 'Event' instances. derEvents :: Lens' DescribeEventsResponse [Event] derEvents = lens _derEvents (\s a -> s { _derEvents = a }) . _List --- | An optional pagination token provided by a previous Events request. If --- this parameter is specified, the response includes only records beyond --- the marker, up to the value specified by MaxRecords . +-- | An optional pagination token provided by a previous Events request. If this +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords' . derMarker :: Lens' DescribeEventsResponse (Maybe Text) derMarker = lens _derMarker (\s a -> s { _derMarker = a }) diff --git a/gen/Network/AWS/RDS/DescribeOptionGroupOptions.hs b/gen/Network/AWS/RDS/DescribeOptionGroupOptions.hs --- a/gen/Network/AWS/RDS/DescribeOptionGroupOptions.hs +++ b/gen/Network/AWS/RDS/DescribeOptionGroupOptions.hs @@ -91,22 +91,25 @@ dogoFilters :: Lens' DescribeOptionGroupOptions [Filter] dogoFilters = lens _dogoFilters (\s a -> s { _dogoFilters = a }) . _List --- | If specified, filters the results to include only options for the --- specified major engine version. +-- | If specified, filters the results to include only options for the specified +-- major engine version. dogoMajorEngineVersion :: Lens' DescribeOptionGroupOptions (Maybe Text) dogoMajorEngineVersion = lens _dogoMajorEngineVersion (\s a -> s { _dogoMajorEngineVersion = a }) -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. dogoMarker :: Lens' DescribeOptionGroupOptions (Maybe Text) dogoMarker = lens _dogoMarker (\s a -> s { _dogoMarker = a }) -- | The maximum number of records to include in the response. If more records --- exist than the specified MaxRecords value, a pagination token called a --- marker is included in the response so that the remaining results can be --- retrieved. Default: 100 Constraints: minimum 20, maximum 100. +-- exist than the specified 'MaxRecords' value, a pagination token called a marker +-- is included in the response so that the remaining results can be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 dogoMaxRecords :: Lens' DescribeOptionGroupOptions (Maybe Int) dogoMaxRecords = lens _dogoMaxRecords (\s a -> s { _dogoMaxRecords = a }) @@ -130,8 +133,8 @@ } -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. dogorMarker :: Lens' DescribeOptionGroupOptionsResponse (Maybe Text) dogorMarker = lens _dogorMarker (\s a -> s { _dogorMarker = a }) diff --git a/gen/Network/AWS/RDS/DescribeOptionGroups.hs b/gen/Network/AWS/RDS/DescribeOptionGroups.hs --- a/gen/Network/AWS/RDS/DescribeOptionGroups.hs +++ b/gen/Network/AWS/RDS/DescribeOptionGroups.hs @@ -86,8 +86,8 @@ , _dogMajorEngineVersion = Nothing } --- | Filters the list of option groups to only include groups associated with --- a specific database engine. +-- | Filters the list of option groups to only include groups associated with a +-- specific database engine. dogEngineName :: Lens' DescribeOptionGroups (Maybe Text) dogEngineName = lens _dogEngineName (\s a -> s { _dogEngineName = a }) @@ -95,28 +95,31 @@ dogFilters :: Lens' DescribeOptionGroups [Filter] dogFilters = lens _dogFilters (\s a -> s { _dogFilters = a }) . _List --- | Filters the list of option groups to only include groups associated with --- a specific database engine version. If specified, then EngineName must --- also be specified. +-- | Filters the list of option groups to only include groups associated with a +-- specific database engine version. If specified, then EngineName must also be +-- specified. dogMajorEngineVersion :: Lens' DescribeOptionGroups (Maybe Text) dogMajorEngineVersion = lens _dogMajorEngineVersion (\s a -> s { _dogMajorEngineVersion = a }) -- | An optional pagination token provided by a previous DescribeOptionGroups --- request. If this parameter is specified, the response includes only --- records beyond the marker, up to the value specified by MaxRecords. +-- request. If this parameter is specified, the response includes only records +-- beyond the marker, up to the value specified by 'MaxRecords'. dogMarker :: Lens' DescribeOptionGroups (Maybe Text) dogMarker = lens _dogMarker (\s a -> s { _dogMarker = a }) -- | The maximum number of records to include in the response. If more records --- exist than the specified MaxRecords value, a pagination token called a --- marker is included in the response so that the remaining results can be --- retrieved. Default: 100 Constraints: minimum 20, maximum 100. +-- exist than the specified 'MaxRecords' value, a pagination token called a marker +-- is included in the response so that the remaining results can be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 dogMaxRecords :: Lens' DescribeOptionGroups (Maybe Int) dogMaxRecords = lens _dogMaxRecords (\s a -> s { _dogMaxRecords = a }) --- | The name of the option group to describe. Cannot be supplied together --- with EngineName or MajorEngineVersion. +-- | The name of the option group to describe. Cannot be supplied together with +-- EngineName or MajorEngineVersion. dogOptionGroupName :: Lens' DescribeOptionGroups (Maybe Text) dogOptionGroupName = lens _dogOptionGroupName (\s a -> s { _dogOptionGroupName = a }) @@ -141,8 +144,8 @@ } -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. dogrMarker :: Lens' DescribeOptionGroupsResponse (Maybe Text) dogrMarker = lens _dogrMarker (\s a -> s { _dogrMarker = a }) diff --git a/gen/Network/AWS/RDS/DescribeOrderableDBInstanceOptions.hs b/gen/Network/AWS/RDS/DescribeOrderableDBInstanceOptions.hs --- a/gen/Network/AWS/RDS/DescribeOrderableDBInstanceOptions.hs +++ b/gen/Network/AWS/RDS/DescribeOrderableDBInstanceOptions.hs @@ -97,8 +97,8 @@ , _dodbioMarker = Nothing } --- | The DB instance class filter value. Specify this parameter to show only --- the available offerings matching the specified DB instance class. +-- | The DB instance class filter value. Specify this parameter to show only the +-- available offerings matching the specified DB instance class. dodbioDBInstanceClass :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) dodbioDBInstanceClass = lens _dodbioDBInstanceClass (\s a -> s { _dodbioDBInstanceClass = a }) @@ -124,21 +124,24 @@ lens _dodbioLicenseModel (\s a -> s { _dodbioLicenseModel = a }) -- | An optional pagination token provided by a previous --- DescribeOrderableDBInstanceOptions request. If this parameter is --- specified, the response includes only records beyond the marker, up to --- the value specified by MaxRecords . +-- DescribeOrderableDBInstanceOptions request. If this parameter is specified, +-- the response includes only records beyond the marker, up to the value +-- specified by 'MaxRecords' . dodbioMarker :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) dodbioMarker = lens _dodbioMarker (\s a -> s { _dodbioMarker = a }) -- | The maximum number of records to include in the response. If more records --- exist than the specified MaxRecords value, a pagination token called a --- marker is included in the response so that the remaining results can be --- retrieved. Default: 100 Constraints: minimum 20, maximum 100. +-- exist than the specified 'MaxRecords' value, a pagination token called a marker +-- is included in the response so that the remaining results can be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 dodbioMaxRecords :: Lens' DescribeOrderableDBInstanceOptions (Maybe Int) dodbioMaxRecords = lens _dodbioMaxRecords (\s a -> s { _dodbioMaxRecords = a }) --- | The VPC filter value. Specify this parameter to show only the available --- VPC or non-VPC offerings. +-- | The VPC filter value. Specify this parameter to show only the available VPC +-- or non-VPC offerings. dodbioVpc :: Lens' DescribeOrderableDBInstanceOptions (Maybe Bool) dodbioVpc = lens _dodbioVpc (\s a -> s { _dodbioVpc = a }) @@ -163,13 +166,13 @@ -- | An optional pagination token provided by a previous -- OrderableDBInstanceOptions request. If this parameter is specified, the --- response includes only records beyond the marker, up to the value --- specified by MaxRecords . +-- response includes only records beyond the marker, up to the value specified +-- by 'MaxRecords' . dodbiorMarker :: Lens' DescribeOrderableDBInstanceOptionsResponse (Maybe Text) dodbiorMarker = lens _dodbiorMarker (\s a -> s { _dodbiorMarker = a }) --- | An OrderableDBInstanceOption structure containing information about --- orderable options for the DB instance. +-- | An 'OrderableDBInstanceOption' structure containing information about orderable +-- options for the DB instance. dodbiorOrderableDBInstanceOptions :: Lens' DescribeOrderableDBInstanceOptionsResponse [OrderableDBInstanceOption] dodbiorOrderableDBInstanceOptions = lens _dodbiorOrderableDBInstanceOptions diff --git a/gen/Network/AWS/RDS/DescribeReservedDBInstances.hs b/gen/Network/AWS/RDS/DescribeReservedDBInstances.hs --- a/gen/Network/AWS/RDS/DescribeReservedDBInstances.hs +++ b/gen/Network/AWS/RDS/DescribeReservedDBInstances.hs @@ -20,8 +20,8 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Returns information about reserved DB instances for this account, or about --- a specified reserved DB instance. +-- | Returns information about reserved DB instances for this account, or about a +-- specified reserved DB instance. -- -- module Network.AWS.RDS.DescribeReservedDBInstances @@ -114,8 +114,9 @@ lens _drdbiDBInstanceClass (\s a -> s { _drdbiDBInstanceClass = a }) -- | The duration filter value, specified in years or seconds. Specify this --- parameter to show only reservations for this duration. Valid Values: 1 | --- 3 | 31536000 | 94608000. +-- parameter to show only reservations for this duration. +-- +-- Valid Values: '1 | 3 | 31536000 | 94608000' drdbiDuration :: Lens' DescribeReservedDBInstances (Maybe Text) drdbiDuration = lens _drdbiDuration (\s a -> s { _drdbiDuration = a }) @@ -124,15 +125,17 @@ drdbiFilters = lens _drdbiFilters (\s a -> s { _drdbiFilters = a }) . _List -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. drdbiMarker :: Lens' DescribeReservedDBInstances (Maybe Text) drdbiMarker = lens _drdbiMarker (\s a -> s { _drdbiMarker = a }) --- | The maximum number of records to include in the response. If more than --- the MaxRecords value is available, a pagination token called a marker is --- included in the response so that the following results can be retrieved. --- Default: 100 Constraints: minimum 20, maximum 100. +-- | The maximum number of records to include in the response. If more than the 'MaxRecords' value is available, a pagination token called a marker is included in the +-- response so that the following results can be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 drdbiMaxRecords :: Lens' DescribeReservedDBInstances (Maybe Int) drdbiMaxRecords = lens _drdbiMaxRecords (\s a -> s { _drdbiMaxRecords = a }) @@ -142,8 +145,9 @@ drdbiMultiAZ = lens _drdbiMultiAZ (\s a -> s { _drdbiMultiAZ = a }) -- | The offering type filter value. Specify this parameter to show only the --- available offerings matching the specified offering type. Valid Values: --- "Light Utilization" | "Medium Utilization" | "Heavy Utilization". +-- available offerings matching the specified offering type. +-- +-- Valid Values: '"Light Utilization" | "Medium Utilization" | "HeavyUtilization" ' drdbiOfferingType :: Lens' DescribeReservedDBInstances (Maybe Text) drdbiOfferingType = lens _drdbiOfferingType (\s a -> s { _drdbiOfferingType = a }) @@ -154,8 +158,8 @@ drdbiProductDescription = lens _drdbiProductDescription (\s a -> s { _drdbiProductDescription = a }) --- | The reserved DB instance identifier filter value. Specify this parameter --- to show only the reservation that matches the specified reservation ID. +-- | The reserved DB instance identifier filter value. Specify this parameter to +-- show only the reservation that matches the specified reservation ID. drdbiReservedDBInstanceId :: Lens' DescribeReservedDBInstances (Maybe Text) drdbiReservedDBInstanceId = lens _drdbiReservedDBInstanceId @@ -188,8 +192,8 @@ } -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. drdbirMarker :: Lens' DescribeReservedDBInstancesResponse (Maybe Text) drdbirMarker = lens _drdbirMarker (\s a -> s { _drdbirMarker = a }) diff --git a/gen/Network/AWS/RDS/DescribeReservedDBInstancesOfferings.hs b/gen/Network/AWS/RDS/DescribeReservedDBInstancesOfferings.hs --- a/gen/Network/AWS/RDS/DescribeReservedDBInstancesOfferings.hs +++ b/gen/Network/AWS/RDS/DescribeReservedDBInstancesOfferings.hs @@ -101,15 +101,16 @@ , _drdbioMarker = Nothing } --- | The DB instance class filter value. Specify this parameter to show only --- the available offerings matching the specified DB instance class. +-- | The DB instance class filter value. Specify this parameter to show only the +-- available offerings matching the specified DB instance class. drdbioDBInstanceClass :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) drdbioDBInstanceClass = lens _drdbioDBInstanceClass (\s a -> s { _drdbioDBInstanceClass = a }) --- | Duration filter value, specified in years or seconds. Specify this --- parameter to show only reservations for this duration. Valid Values: 1 | --- 3 | 31536000 | 94608000. +-- | Duration filter value, specified in years or seconds. Specify this parameter +-- to show only reservations for this duration. +-- +-- Valid Values: '1 | 3 | 31536000 | 94608000' drdbioDuration :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) drdbioDuration = lens _drdbioDuration (\s a -> s { _drdbioDuration = a }) @@ -118,26 +119,29 @@ drdbioFilters = lens _drdbioFilters (\s a -> s { _drdbioFilters = a }) . _List -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. drdbioMarker :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) drdbioMarker = lens _drdbioMarker (\s a -> s { _drdbioMarker = a }) --- | The maximum number of records to include in the response. If more than --- the MaxRecords value is available, a pagination token called a marker is --- included in the response so that the following results can be retrieved. --- Default: 100 Constraints: minimum 20, maximum 100. +-- | The maximum number of records to include in the response. If more than the 'MaxRecords' value is available, a pagination token called a marker is included in the +-- response so that the following results can be retrieved. +-- +-- Default: 100 +-- +-- Constraints: minimum 20, maximum 100 drdbioMaxRecords :: Lens' DescribeReservedDBInstancesOfferings (Maybe Int) drdbioMaxRecords = lens _drdbioMaxRecords (\s a -> s { _drdbioMaxRecords = a }) --- | The Multi-AZ filter value. Specify this parameter to show only the --- available offerings matching the specified Multi-AZ parameter. +-- | The Multi-AZ filter value. Specify this parameter to show only the available +-- offerings matching the specified Multi-AZ parameter. drdbioMultiAZ :: Lens' DescribeReservedDBInstancesOfferings (Maybe Bool) drdbioMultiAZ = lens _drdbioMultiAZ (\s a -> s { _drdbioMultiAZ = a }) -- | The offering type filter value. Specify this parameter to show only the --- available offerings matching the specified offering type. Valid Values: --- "Light Utilization" | "Medium Utilization" | "Heavy Utilization". +-- available offerings matching the specified offering type. +-- +-- Valid Values: '"Light Utilization" | "Medium Utilization" | "HeavyUtilization" ' drdbioOfferingType :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) drdbioOfferingType = lens _drdbioOfferingType (\s a -> s { _drdbioOfferingType = a }) @@ -151,7 +155,8 @@ -- | The offering identifier filter value. Specify this parameter to show only -- the available offering that matches the specified reservation identifier. --- Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706. +-- +-- Example: '438012d3-4052-4cc7-b2e3-8d3372e0e706' drdbioReservedDBInstancesOfferingId :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) drdbioReservedDBInstancesOfferingId = lens _drdbioReservedDBInstancesOfferingId @@ -177,8 +182,8 @@ } -- | An optional pagination token provided by a previous request. If this --- parameter is specified, the response includes only records beyond the --- marker, up to the value specified by MaxRecords. +-- parameter is specified, the response includes only records beyond the marker, +-- up to the value specified by 'MaxRecords'. drdbiorMarker :: Lens' DescribeReservedDBInstancesOfferingsResponse (Maybe Text) drdbiorMarker = lens _drdbiorMarker (\s a -> s { _drdbiorMarker = a }) diff --git a/gen/Network/AWS/RDS/DownloadDBLogFilePortion.hs b/gen/Network/AWS/RDS/DownloadDBLogFilePortion.hs --- a/gen/Network/AWS/RDS/DownloadDBLogFilePortion.hs +++ b/gen/Network/AWS/RDS/DownloadDBLogFilePortion.hs @@ -80,9 +80,13 @@ } -- | The customer-assigned name of the DB instance that contains the log files --- you want to list. Constraints: Must contain from 1 to 63 alphanumeric --- characters or hyphens First character must be a letter Cannot end with a --- hyphen or contain two consecutive hyphens. +-- you want to list. +-- +-- Constraints: +-- +-- Must contain from 1 to 63 alphanumeric characters or hyphens First +-- character must be a letter Cannot end with a hyphen or contain two +-- consecutive hyphens ddblfpDBInstanceIdentifier :: Lens' DownloadDBLogFilePortion Text ddblfpDBInstanceIdentifier = lens _ddblfpDBInstanceIdentifier @@ -93,25 +97,32 @@ ddblfpLogFileName = lens _ddblfpLogFileName (\s a -> s { _ddblfpLogFileName = a }) --- | The pagination token provided in the previous request or "0". If the --- Marker parameter is specified the response includes only records beyond --- the marker until the end of the file or up to NumberOfLines. +-- | The pagination token provided in the previous request or "0". If the Marker +-- parameter is specified the response includes only records beyond the marker +-- until the end of the file or up to NumberOfLines. ddblfpMarker :: Lens' DownloadDBLogFilePortion (Maybe Text) ddblfpMarker = lens _ddblfpMarker (\s a -> s { _ddblfpMarker = a }) --- | The number of lines to download. If the NumberOfLines parameter is --- specified, then the block of lines returned can be from the beginning or --- the end of the log file, depending on the value of the Marker parameter. --- If neither Marker or NumberOfLines are specified, the entire log file is --- returned. If NumberOfLines is specified and Marker is not specified, then --- the most recent lines from the end of the log file are returned. If --- Marker is specified as "0", then the specified number of lines from the --- beginning of the log file are returned. You can download the log file in --- blocks of lines by specifying the size of the block using the --- NumberOfLines parameter, and by specifying a value of "0" for the Marker --- parameter in your first request. Include the Marker value returned in the --- response as the Marker value for the next request, continuing until the --- AdditionalDataPending response element returns false. +-- | The number of lines to download. +-- +-- If the NumberOfLines parameter is specified, then the block of lines +-- returned can be from the beginning or the end of the log file, depending on +-- the value of the Marker parameter. If neither Marker or NumberOfLines are +-- specified, the entire log file is returned. +-- +-- If NumberOfLines is specified and Marker is not specified, then the most +-- recent lines from the end of the log file are returned. +-- +-- If Marker is specified as "0", then the specified number of lines from the +-- beginning of the log file are returned. +-- +-- You can download the log file in blocks of lines by specifying the size of +-- the block using the NumberOfLines parameter, and by specifying a value of "0" +-- for the Marker parameter in your first request. Include the Marker value +-- returned in the response as the Marker value for the next request, continuing +-- until the AdditionalDataPending response element returns false. +-- +-- ddblfpNumberOfLines :: Lens' DownloadDBLogFilePortion (Maybe Int) ddblfpNumberOfLines = lens _ddblfpNumberOfLines (\s a -> s { _ddblfpNumberOfLines = a }) @@ -139,8 +150,7 @@ , _ddblfprAdditionalDataPending = Nothing } --- | Boolean value that if true, indicates there is more data to be --- downloaded. +-- | Boolean value that if true, indicates there is more data to be downloaded. ddblfprAdditionalDataPending :: Lens' DownloadDBLogFilePortionResponse (Maybe Bool) ddblfprAdditionalDataPending = lens _ddblfprAdditionalDataPending @@ -151,8 +161,8 @@ ddblfprLogFileData = lens _ddblfprLogFileData (\s a -> s { _ddblfprLogFileData = a }) --- | A pagination token that can be used in a subsequent --- DownloadDBLogFilePortion request. +-- | A pagination token that can be used in a subsequent DownloadDBLogFilePortion +-- request. ddblfprMarker :: Lens' DownloadDBLogFilePortionResponse (Maybe Text) ddblfprMarker = lens _ddblfprMarker (\s a -> s { _ddblfprMarker = a }) diff --git a/gen/Network/AWS/RDS/ListTagsForResource.hs b/gen/Network/AWS/RDS/ListTagsForResource.hs --- a/gen/Network/AWS/RDS/ListTagsForResource.hs +++ b/gen/Network/AWS/RDS/ListTagsForResource.hs @@ -20,9 +20,10 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Lists all tags on an Amazon RDS resource. For an overview on tagging an --- Amazon RDS resource, see Tagging Amazon RDS Resources. +-- | Lists all tags on an Amazon RDS resource. -- +-- For an overview on tagging an Amazon RDS resource, see . +-- -- module Network.AWS.RDS.ListTagsForResource ( @@ -72,8 +73,7 @@ ltfrFilters = lens _ltfrFilters (\s a -> s { _ltfrFilters = a }) . _List -- | The Amazon RDS resource with tags to be listed. This value is an Amazon --- Resource Name (ARN). For information about creating an ARN, see --- Constructing an RDS Amazon Resource Name (ARN). +-- Resource Name (ARN). For information about creating an ARN, see . ltfrResourceName :: Lens' ListTagsForResource Text ltfrResourceName = lens _ltfrResourceName (\s a -> s { _ltfrResourceName = a }) diff --git a/gen/Network/AWS/RDS/ModifyDBInstance.hs b/gen/Network/AWS/RDS/ModifyDBInstance.hs --- a/gen/Network/AWS/RDS/ModifyDBInstance.hs +++ b/gen/Network/AWS/RDS/ModifyDBInstance.hs @@ -21,8 +21,8 @@ -- Portability : non-portable (GHC extensions) -- | Modify settings for a DB instance. You can change one or more database --- configuration parameters by specifying these parameters and the new values --- in the request. +-- configuration parameters by specifying these parameters and the new values in +-- the request. -- -- module Network.AWS.RDS.ModifyDBInstance @@ -163,133 +163,177 @@ , _mdbiTdeCredentialPassword = Nothing } --- | The new storage capacity of the RDS instance. Changing this setting does --- not result in an outage and the change is applied during the next --- maintenance window unless ApplyImmediately is set to true for this --- request. MySQL Default: Uses existing setting Valid Values: 5-3072 +-- | The new storage capacity of the RDS instance. Changing this setting does not +-- result in an outage and the change is applied during the next maintenance +-- window unless 'ApplyImmediately' is set to 'true' for this request. +-- +-- MySQL +-- +-- Default: Uses existing setting +-- +-- Valid Values: 5-3072 +-- -- Constraints: Value supplied must be at least 10% greater than the current --- value. Values that are not at least 10% greater than the existing value --- are rounded up so that they are 10% greater than the current value. Type: --- Integer PostgreSQL Default: Uses existing setting Valid Values: 5-3072 +-- value. Values that are not at least 10% greater than the existing value are +-- rounded up so that they are 10% greater than the current value. +-- +-- Type: Integer +-- +-- PostgreSQL +-- +-- Default: Uses existing setting +-- +-- Valid Values: 5-3072 +-- -- Constraints: Value supplied must be at least 10% greater than the current --- value. Values that are not at least 10% greater than the existing value --- are rounded up so that they are 10% greater than the current value. Type: --- Integer Oracle Default: Uses existing setting Valid Values: 10-3072 +-- value. Values that are not at least 10% greater than the existing value are +-- rounded up so that they are 10% greater than the current value. +-- +-- Type: Integer +-- +-- Oracle +-- +-- Default: Uses existing setting +-- +-- Valid Values: 10-3072 +-- -- Constraints: Value supplied must be at least 10% greater than the current --- value. Values that are not at least 10% greater than the existing value --- are rounded up so that they are 10% greater than the current value. SQL --- Server Cannot be modified. If you choose to migrate your DB instance from --- using standard storage to using Provisioned IOPS, or from using --- Provisioned IOPS to using standard storage, the process can take time. --- The duration of the migration depends on several factors such as database --- load, storage size, storage type (standard or Provisioned IOPS), amount --- of IOPS provisioned (if any), and the number of prior scale storage --- operations. Typical migration times are under 24 hours, but the process --- can take up to several days in some cases. During the migration, the DB --- instance will be available for use, but may experience performance --- degradation. While the migration takes place, nightly backups for the --- instance will be suspended. No other Amazon RDS operations can take place --- for the instance, including modifying the instance, rebooting the --- instance, deleting the instance, creating a read replica for the --- instance, and creating a DB snapshot of the instance. +-- value. Values that are not at least 10% greater than the existing value are +-- rounded up so that they are 10% greater than the current value. +-- +-- SQL Server +-- +-- Cannot be modified. +-- +-- If you choose to migrate your DB instance from using standard storage to +-- using Provisioned IOPS, or from using Provisioned IOPS to using standard +-- storage, the process can take time. The duration of the migration depends on +-- several factors such as database load, storage size, storage type (standard +-- or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of +-- prior scale storage operations. Typical migration times are under 24 hours, +-- but the process can take up to several days in some cases. During the +-- migration, the DB instance will be available for use, but may experience +-- performance degradation. While the migration takes place, nightly backups for +-- the instance will be suspended. No other Amazon RDS operations can take place +-- for the instance, including modifying the instance, rebooting the instance, +-- deleting the instance, creating a read replica for the instance, and creating +-- a DB snapshot of the instance. mdbiAllocatedStorage :: Lens' ModifyDBInstance (Maybe Int) mdbiAllocatedStorage = lens _mdbiAllocatedStorage (\s a -> s { _mdbiAllocatedStorage = a }) --- | Indicates that major version upgrades are allowed. Changing this --- parameter does not result in an outage and the change is asynchronously --- applied as soon as possible. Constraints: This parameter must be set to --- true when specifying a value for the EngineVersion parameter that is a --- different major version than the DB instance's current version. +-- | Indicates that major version upgrades are allowed. Changing this parameter +-- does not result in an outage and the change is asynchronously applied as soon +-- as possible. +-- +-- Constraints: This parameter must be set to true when specifying a value for +-- the EngineVersion parameter that is a different major version than the DB +-- instance's current version. mdbiAllowMajorVersionUpgrade :: Lens' ModifyDBInstance (Maybe Bool) mdbiAllowMajorVersionUpgrade = lens _mdbiAllowMajorVersionUpgrade (\s a -> s { _mdbiAllowMajorVersionUpgrade = a }) -- | Specifies whether the modifications in this request and any pending --- modifications are asynchronously applied as soon as possible, regardless --- of the PreferredMaintenanceWindow setting for the DB instance. If this --- parameter is set to false, changes to the DB instance are applied during --- the next maintenance window. Some parameter changes can cause an outage --- and will be applied on the next call to RebootDBInstance, or the next --- failure reboot. Review the table of parameters in Modifying a DB Instance --- and Using the Apply Immediately Parameter to see the impact that setting --- ApplyImmediately to true or false has for each modified parameter and to --- determine when the changes will be applied. Default: false. +-- modifications are asynchronously applied as soon as possible, regardless of +-- the 'PreferredMaintenanceWindow' setting for the DB instance. +-- +-- If this parameter is set to 'false', changes to the DB instance are applied +-- during the next maintenance window. Some parameter changes can cause an +-- outage and will be applied on the next call to 'RebootDBInstance', or the next +-- failure reboot. Review the table of parameters in to see the impact that setting 'ApplyImmediately' to 'true' or 'false' has for each modified parameter and to determine when the +-- changes will be applied. +-- +-- Default: 'false' mdbiApplyImmediately :: Lens' ModifyDBInstance (Maybe Bool) mdbiApplyImmediately = lens _mdbiApplyImmediately (\s a -> s { _mdbiApplyImmediately = a }) --- | Indicates that minor version upgrades will be applied automatically to --- the DB instance during the maintenance window. Changing this parameter --- does not result in an outage except in the following case and the change --- is asynchronously applied as soon as possible. An outage will result if --- this parameter is set to true during the maintenance window, and a newer --- minor version is available, and RDS has enabled auto patching for that --- engine version. +-- | Indicates that minor version upgrades will be applied automatically to the +-- DB instance during the maintenance window. Changing this parameter does not +-- result in an outage except in the following case and the change is +-- asynchronously applied as soon as possible. An outage will result if this +-- parameter is set to 'true' during the maintenance window, and a newer minor +-- version is available, and RDS has enabled auto patching for that engine +-- version. mdbiAutoMinorVersionUpgrade :: Lens' ModifyDBInstance (Maybe Bool) mdbiAutoMinorVersionUpgrade = lens _mdbiAutoMinorVersionUpgrade (\s a -> s { _mdbiAutoMinorVersionUpgrade = a }) --- | The number of days to retain automated backups. Setting this parameter to --- a positive number enables backups. Setting this parameter to 0 disables --- automated backups. Changing this parameter can result in an outage if you --- change from 0 to a non-zero value or from a non-zero value to 0. These --- changes are applied during the next maintenance window unless the --- ApplyImmediately parameter is set to true for this request. If you change --- the parameter from one non-zero value to another non-zero value, the --- change is asynchronously applied as soon as possible. Default: Uses --- existing setting Constraints: Must be a value from 0 to 35 Can be --- specified for a read replica only if the source is running MySQL 5.6 --- Cannot be set to 0 if the DB instance is a source to read replicas. +-- | The number of days to retain automated backups. Setting this parameter to a +-- positive number enables backups. Setting this parameter to 0 disables +-- automated backups. +-- +-- Changing this parameter can result in an outage if you change from 0 to a +-- non-zero value or from a non-zero value to 0. These changes are applied +-- during the next maintenance window unless the 'ApplyImmediately' parameter is +-- set to 'true' for this request. If you change the parameter from one non-zero +-- value to another non-zero value, the change is asynchronously applied as soon +-- as possible. +-- +-- Default: Uses existing setting +-- +-- Constraints: +-- +-- Must be a value from 0 to 35 Can be specified for a read replica only if +-- the source is running MySQL 5.6 Cannot be set to 0 if the DB instance is a +-- source to read replicas mdbiBackupRetentionPeriod :: Lens' ModifyDBInstance (Maybe Int) mdbiBackupRetentionPeriod = lens _mdbiBackupRetentionPeriod (\s a -> s { _mdbiBackupRetentionPeriod = a }) -- | The new compute and memory capacity of the DB instance. To determine the --- instance classes that are available for a particular DB engine, use the --- DescribeOrderableDBInstanceOptions action. Passing a value for this --- setting causes an outage during the change and is applied during the next --- maintenance window, unless ApplyImmediately is specified as true for this --- request. Default: Uses existing setting Valid Values: db.t1.micro | --- db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | --- db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge --- | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | --- db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium. +-- instance classes that are available for a particular DB engine, use the 'DescribeOrderableDBInstanceOptions' action. +-- +-- Passing a value for this setting causes an outage during the change and is +-- applied during the next maintenance window, unless 'ApplyImmediately' is +-- specified as 'true' for this request. +-- +-- Default: Uses existing setting +-- +-- Valid Values: 'db.t1.micro | db.m1.small | db.m1.medium | db.m1.large |db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium |db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge |db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small |db.t2.medium' mdbiDBInstanceClass :: Lens' ModifyDBInstance (Maybe Text) mdbiDBInstanceClass = lens _mdbiDBInstanceClass (\s a -> s { _mdbiDBInstanceClass = a }) -- | The DB instance identifier. This value is stored as a lowercase string. --- Constraints: Must be the identifier for an existing DB instance Must --- contain from 1 to 63 alphanumeric characters or hyphens First character --- must be a letter Cannot end with a hyphen or contain two consecutive --- hyphens. +-- +-- Constraints: +-- +-- Must be the identifier for an existing DB instance Must contain from 1 to +-- 63 alphanumeric characters or hyphens First character must be a letter Cannot +-- end with a hyphen or contain two consecutive hyphens mdbiDBInstanceIdentifier :: Lens' ModifyDBInstance Text mdbiDBInstanceIdentifier = lens _mdbiDBInstanceIdentifier (\s a -> s { _mdbiDBInstanceIdentifier = a }) -- | The name of the DB parameter group to apply to the DB instance. Changing --- this setting does not result in an outage. The parameter group name --- itself is changed immediately, but the actual parameter changes are not --- applied until you reboot the instance without failover. The db instance --- will NOT be rebooted automatically and the parameter changes will NOT be --- applied during the next maintenance window. Default: Uses existing --- setting Constraints: The DB parameter group must be in the same DB --- parameter group family as this DB instance. +-- this setting does not result in an outage. The parameter group name itself is +-- changed immediately, but the actual parameter changes are not applied until +-- you reboot the instance without failover. The db instance will NOT be +-- rebooted automatically and the parameter changes will NOT be applied during +-- the next maintenance window. +-- +-- Default: Uses existing setting +-- +-- Constraints: The DB parameter group must be in the same DB parameter group +-- family as this DB instance. mdbiDBParameterGroupName :: Lens' ModifyDBInstance (Maybe Text) mdbiDBParameterGroupName = lens _mdbiDBParameterGroupName (\s a -> s { _mdbiDBParameterGroupName = a }) --- | A list of DB security groups to authorize on this DB instance. Changing --- this setting does not result in an outage and the change is --- asynchronously applied as soon as possible. Constraints: Must be 1 to 255 --- alphanumeric characters First character must be a letter Cannot end with --- a hyphen or contain two consecutive hyphens. +-- | A list of DB security groups to authorize on this DB instance. Changing this +-- setting does not result in an outage and the change is asynchronously applied +-- as soon as possible. +-- +-- Constraints: +-- +-- Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens +-- mdbiDBSecurityGroups :: Lens' ModifyDBInstance [Text] mdbiDBSecurityGroups = lens _mdbiDBSecurityGroups (\s a -> s { _mdbiDBSecurityGroups = a }) @@ -297,123 +341,154 @@ -- | The version number of the database engine to upgrade to. Changing this -- parameter results in an outage and the change is applied during the next --- maintenance window unless the ApplyImmediately parameter is set to true --- for this request. For major version upgrades, if a non-default DB --- parameter group is currently in use, a new DB parameter group in the DB --- parameter group family for the new engine version must be specified. The --- new DB parameter group can be the default for that DB parameter group --- family. Example: 5.1.42. +-- maintenance window unless the 'ApplyImmediately' parameter is set to 'true' for +-- this request. +-- +-- For major version upgrades, if a non-default DB parameter group is +-- currently in use, a new DB parameter group in the DB parameter group family +-- for the new engine version must be specified. The new DB parameter group can +-- be the default for that DB parameter group family. +-- +-- Example: '5.1.42' mdbiEngineVersion :: Lens' ModifyDBInstance (Maybe Text) mdbiEngineVersion = lens _mdbiEngineVersion (\s a -> s { _mdbiEngineVersion = a }) -- | The new Provisioned IOPS (I/O operations per second) value for the RDS --- instance. Changing this setting does not result in an outage and the --- change is applied during the next maintenance window unless the --- ApplyImmediately parameter is set to true for this request. Default: Uses --- existing setting Constraints: Value supplied must be at least 10% greater --- than the current value. Values that are not at least 10% greater than the --- existing value are rounded up so that they are 10% greater than the --- current value. If you are migrating from Provisioned IOPS to standard --- storage, set this value to 0. The DB instance will require a reboot for --- the change in storage type to take effect. SQL Server Setting the IOPS --- value for the SQL Server database engine is not supported. Type: Integer +-- instance. Changing this setting does not result in an outage and the change +-- is applied during the next maintenance window unless the 'ApplyImmediately' +-- parameter is set to 'true' for this request. +-- +-- Default: Uses existing setting +-- +-- Constraints: Value supplied must be at least 10% greater than the current +-- value. Values that are not at least 10% greater than the existing value are +-- rounded up so that they are 10% greater than the current value. If you are +-- migrating from Provisioned IOPS to standard storage, set this value to 0. The +-- DB instance will require a reboot for the change in storage type to take +-- effect. +-- +-- SQL Server +-- +-- Setting the IOPS value for the SQL Server database engine is not supported. +-- +-- Type: Integer +-- -- If you choose to migrate your DB instance from using standard storage to -- using Provisioned IOPS, or from using Provisioned IOPS to using standard --- storage, the process can take time. The duration of the migration depends --- on several factors such as database load, storage size, storage type --- (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and --- the number of prior scale storage operations. Typical migration times are --- under 24 hours, but the process can take up to several days in some --- cases. During the migration, the DB instance will be available for use, --- but may experience performance degradation. While the migration takes --- place, nightly backups for the instance will be suspended. No other --- Amazon RDS operations can take place for the instance, including --- modifying the instance, rebooting the instance, deleting the instance, --- creating a read replica for the instance, and creating a DB snapshot of --- the instance. +-- storage, the process can take time. The duration of the migration depends on +-- several factors such as database load, storage size, storage type (standard +-- or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of +-- prior scale storage operations. Typical migration times are under 24 hours, +-- but the process can take up to several days in some cases. During the +-- migration, the DB instance will be available for use, but may experience +-- performance degradation. While the migration takes place, nightly backups for +-- the instance will be suspended. No other Amazon RDS operations can take place +-- for the instance, including modifying the instance, rebooting the instance, +-- deleting the instance, creating a read replica for the instance, and creating +-- a DB snapshot of the instance. mdbiIops :: Lens' ModifyDBInstance (Maybe Int) mdbiIops = lens _mdbiIops (\s a -> s { _mdbiIops = a }) --- | The new password for the DB instance master user. Can be any printable --- ASCII character except "/", """, or "@". Changing this parameter does not --- result in an outage and the change is asynchronously applied as soon as --- possible. Between the time of the request and the completion of the --- request, the MasterUserPassword element exists in the --- PendingModifiedValues element of the operation response. Default: Uses --- existing setting Constraints: Must be 8 to 41 alphanumeric characters --- (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 --- alphanumeric characters (SQL Server). +-- | The new password for the DB instance master user. Can be any printable ASCII +-- character except "/", """, or "@". +-- +-- Changing this parameter does not result in an outage and the change is +-- asynchronously applied as soon as possible. Between the time of the request +-- and the completion of the request, the 'MasterUserPassword' element exists in +-- the 'PendingModifiedValues' element of the operation response. +-- +-- Default: Uses existing setting +-- +-- Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 +-- alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL +-- Server). mdbiMasterUserPassword :: Lens' ModifyDBInstance (Maybe Text) mdbiMasterUserPassword = lens _mdbiMasterUserPassword (\s a -> s { _mdbiMasterUserPassword = a }) -- | Specifies if the DB instance is a Multi-AZ deployment. Changing this --- parameter does not result in an outage and the change is applied during --- the next maintenance window unless the ApplyImmediately parameter is set --- to true for this request. Constraints: Cannot be specified if the DB --- instance is a read replica. +-- parameter does not result in an outage and the change is applied during the +-- next maintenance window unless the 'ApplyImmediately' parameter is set to 'true' +-- for this request. +-- +-- Constraints: Cannot be specified if the DB instance is a read replica. mdbiMultiAZ :: Lens' ModifyDBInstance (Maybe Bool) mdbiMultiAZ = lens _mdbiMultiAZ (\s a -> s { _mdbiMultiAZ = a }) -- | The new DB instance identifier for the DB instance when renaming a DB --- instance. When you change the DB instance identifier, an instance reboot --- will occur immediately if you set Apply Immediately to true, or will --- occur during the next maintenance window if Apply Immediately to false. --- This value is stored as a lowercase string. Constraints: Must contain --- from 1 to 63 alphanumeric characters or hyphens First character must be a --- letter Cannot end with a hyphen or contain two consecutive hyphens. +-- instance. When you change the DB instance identifier, an instance reboot will +-- occur immediately if you set 'Apply Immediately' to true, or will occur during +-- the next maintenance window if 'Apply Immediately' to false. This value is +-- stored as a lowercase string. +-- +-- Constraints: +-- +-- Must contain from 1 to 63 alphanumeric characters or hyphens First +-- character must be a letter Cannot end with a hyphen or contain two +-- consecutive hyphens mdbiNewDBInstanceIdentifier :: Lens' ModifyDBInstance (Maybe Text) mdbiNewDBInstanceIdentifier = lens _mdbiNewDBInstanceIdentifier (\s a -> s { _mdbiNewDBInstanceIdentifier = a }) -- | Indicates that the DB instance should be associated with the specified --- option group. Changing this parameter does not result in an outage except --- in the following case and the change is applied during the next --- maintenance window unless the ApplyImmediately parameter is set to true --- for this request. If the parameter change results in an option group that --- enables OEM, this change can cause a brief (sub-second) period during --- which new connections are rejected but existing connections are not --- interrupted. Permanent options, such as the TDE option for Oracle --- Advanced Security TDE, cannot be removed from an option group, and that --- option group cannot be removed from a DB instance once it is associated --- with a DB instance. +-- option group. Changing this parameter does not result in an outage except in +-- the following case and the change is applied during the next maintenance +-- window unless the 'ApplyImmediately' parameter is set to 'true' for this request. +-- If the parameter change results in an option group that enables OEM, this +-- change can cause a brief (sub-second) period during which new connections are +-- rejected but existing connections are not interrupted. +-- +-- Permanent options, such as the TDE option for Oracle Advanced Security TDE, +-- cannot be removed from an option group, and that option group cannot be +-- removed from a DB instance once it is associated with a DB instance mdbiOptionGroupName :: Lens' ModifyDBInstance (Maybe Text) mdbiOptionGroupName = lens _mdbiOptionGroupName (\s a -> s { _mdbiOptionGroupName = a }) --- | The daily time range during which automated backups are created if --- automated backups are enabled, as determined by the --- BackupRetentionPeriod. Changing this parameter does not result in an --- outage and the change is asynchronously applied as soon as possible. --- Constraints: Must be in the format hh24:mi-hh24:mi Times should be --- Universal Time Coordinated (UTC) Must not conflict with the preferred --- maintenance window Must be at least 30 minutes. +-- | The daily time range during which automated backups are created if automated +-- backups are enabled, as determined by the 'BackupRetentionPeriod'. Changing +-- this parameter does not result in an outage and the change is asynchronously +-- applied as soon as possible. +-- +-- Constraints: +-- +-- Must be in the format hh24:mi-hh24:mi Times should be Universal Time +-- Coordinated (UTC) Must not conflict with the preferred maintenance window Must be at least 30 minutes +-- mdbiPreferredBackupWindow :: Lens' ModifyDBInstance (Maybe Text) mdbiPreferredBackupWindow = lens _mdbiPreferredBackupWindow (\s a -> s { _mdbiPreferredBackupWindow = a }) -- | The weekly time range (in UTC) during which system maintenance can occur, --- which may result in an outage. Changing this parameter does not result in --- an outage, except in the following situation, and the change is --- asynchronously applied as soon as possible. If there are pending actions --- that cause a reboot, and the maintenance window is changed to include the --- current time, then changing this parameter will cause a reboot of the DB --- instance. If moving this window to the current time, there must be at --- least 30 minutes between the current time and end of the window to ensure --- pending changes are applied. Default: Uses existing setting Format: --- ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | --- Sun Constraints: Must be at least 30 minutes. +-- which may result in an outage. Changing this parameter does not result in an +-- outage, except in the following situation, and the change is asynchronously +-- applied as soon as possible. If there are pending actions that cause a +-- reboot, and the maintenance window is changed to include the current time, +-- then changing this parameter will cause a reboot of the DB instance. If +-- moving this window to the current time, there must be at least 30 minutes +-- between the current time and end of the window to ensure pending changes are +-- applied. +-- +-- Default: Uses existing setting +-- +-- Format: ddd:hh24:mi-ddd:hh24:mi +-- +-- Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun +-- +-- Constraints: Must be at least 30 minutes mdbiPreferredMaintenanceWindow :: Lens' ModifyDBInstance (Maybe Text) mdbiPreferredMaintenanceWindow = lens _mdbiPreferredMaintenanceWindow (\s a -> s { _mdbiPreferredMaintenanceWindow = a }) --- | Specifies storage type to be associated with the DB Instance. Valid --- values: standard | gp2 | io1 If you specify io1, you must also include a --- value for the Iops parameter. +-- | Specifies storage type to be associated with the DB Instance. +-- +-- Valid values: 'standard | gp2 | io1' +-- +-- If you specify 'io1', you must also include a value for the 'Iops' parameter. mdbiStorageType :: Lens' ModifyDBInstance (Maybe Text) mdbiStorageType = lens _mdbiStorageType (\s a -> s { _mdbiStorageType = a }) @@ -431,9 +506,12 @@ (\s a -> s { _mdbiTdeCredentialPassword = a }) -- | A list of EC2 VPC security groups to authorize on this DB instance. This --- change is asynchronously applied as soon as possible. Constraints: Must --- be 1 to 255 alphanumeric characters First character must be a letter --- Cannot end with a hyphen or contain two consecutive hyphens. +-- change is asynchronously applied as soon as possible. +-- +-- Constraints: +-- +-- Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens +-- mdbiVpcSecurityGroupIds :: Lens' ModifyDBInstance [Text] mdbiVpcSecurityGroupIds = lens _mdbiVpcSecurityGroupIds (\s a -> s { _mdbiVpcSecurityGroupIds = a }) diff --git a/gen/Network/AWS/RDS/ModifyDBParameterGroup.hs b/gen/Network/AWS/RDS/ModifyDBParameterGroup.hs --- a/gen/Network/AWS/RDS/ModifyDBParameterGroup.hs +++ b/gen/Network/AWS/RDS/ModifyDBParameterGroup.hs @@ -21,19 +21,19 @@ -- Portability : non-portable (GHC extensions) -- | Modifies the parameters of a DB parameter group. To modify more than one --- parameter, submit a list of the following: ParameterName, ParameterValue, --- and ApplyMethod. A maximum of 20 parameters can be modified in a single --- request. After you modify a DB parameter group, you should wait at least 5 --- minutes before creating your first DB instance that uses that DB parameter --- group as the default parameter group. This allows Amazon RDS to fully --- complete the modify action before the parameter group is used as the --- default for a new DB instance. This is especially important for parameters --- that are critical when creating the default database for a DB instance, --- such as the character set for the default database defined by the --- character_set_database parameter. You can use the Parameter Groups option --- of the Amazon RDS console or the DescribeDBParameters command to verify --- that your DB parameter group has been created or modified. +-- parameter, submit a list of the following: 'ParameterName', 'ParameterValue', and 'ApplyMethod'. A maximum of 20 parameters can be modified in a single request. -- +-- After you modify a DB parameter group, you should wait at least 5 minutes +-- before creating your first DB instance that uses that DB parameter group as +-- the default parameter group. This allows Amazon RDS to fully complete the +-- modify action before the parameter group is used as the default for a new DB +-- instance. This is especially important for parameters that are critical when +-- creating the default database for a DB instance, such as the character set +-- for the default database defined by the 'character_set_database' parameter. You +-- can use the /Parameter Groups/ option of the or the /DescribeDBParameters/ command to verify that your DB parameter group has been created or modified. +-- +-- +-- -- module Network.AWS.RDS.ModifyDBParameterGroup ( @@ -78,20 +78,24 @@ , _mdbpgParameters = mempty } --- | The name of the DB parameter group. Constraints: Must be the name of an --- existing DB parameter group Must be 1 to 255 alphanumeric characters --- First character must be a letter Cannot end with a hyphen or contain two --- consecutive hyphens. +-- | The name of the DB parameter group. +-- +-- Constraints: +-- +-- Must be the name of an existing DB parameter group Must be 1 to 255 +-- alphanumeric characters First character must be a letter Cannot end with a +-- hyphen or contain two consecutive hyphens mdbpgDBParameterGroupName :: Lens' ModifyDBParameterGroup Text mdbpgDBParameterGroupName = lens _mdbpgDBParameterGroupName (\s a -> s { _mdbpgDBParameterGroupName = a }) --- | An array of parameter names, values, and the apply method for the --- parameter update. At least one parameter name, value, and apply method --- must be supplied; subsequent arguments are optional. A maximum of 20 --- parameters may be modified in a single request. Valid Values (for the --- application method): immediate | pending-reboot. +-- | An array of parameter names, values, and the apply method for the parameter +-- update. At least one parameter name, value, and apply method must be +-- supplied; subsequent arguments are optional. A maximum of 20 parameters may +-- be modified in a single request. +-- +-- Valid Values (for the application method): 'immediate | pending-reboot' mdbpgParameters :: Lens' ModifyDBParameterGroup [Parameter] mdbpgParameters = lens _mdbpgParameters (\s a -> s { _mdbpgParameters = a }) . _List diff --git a/gen/Network/AWS/RDS/ModifyDBSubnetGroup.hs b/gen/Network/AWS/RDS/ModifyDBSubnetGroup.hs --- a/gen/Network/AWS/RDS/ModifyDBSubnetGroup.hs +++ b/gen/Network/AWS/RDS/ModifyDBSubnetGroup.hs @@ -20,8 +20,8 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Modifies an existing DB subnet group. DB subnet groups must contain at --- least one subnet in at least two AZs in the region. +-- | Modifies an existing DB subnet group. DB subnet groups must contain at least +-- one subnet in at least two AZs in the region. -- -- module Network.AWS.RDS.ModifyDBSubnetGroup @@ -79,8 +79,12 @@ (\s a -> s { _mdbsgDBSubnetGroupDescription = a }) -- | The name for the DB subnet group. This value is stored as a lowercase --- string. Constraints: Must contain no more than 255 alphanumeric --- characters or hyphens. Must not be "Default". Example: mySubnetgroup. +-- string. +-- +-- Constraints: Must contain no more than 255 alphanumeric characters or +-- hyphens. Must not be "Default". +-- +-- Example: 'mySubnetgroup' mdbsgDBSubnetGroupName :: Lens' ModifyDBSubnetGroup Text mdbsgDBSubnetGroupName = lens _mdbsgDBSubnetGroupName (\s a -> s { _mdbsgDBSubnetGroupName = a }) diff --git a/gen/Network/AWS/RDS/ModifyEventSubscription.hs b/gen/Network/AWS/RDS/ModifyEventSubscription.hs --- a/gen/Network/AWS/RDS/ModifyEventSubscription.hs +++ b/gen/Network/AWS/RDS/ModifyEventSubscription.hs @@ -22,11 +22,11 @@ -- | Modifies an existing RDS event notification subscription. Note that you -- cannot modify the source identifiers using this call; to change source --- identifiers for a subscription, use the AddSourceIdentifierToSubscription --- and RemoveSourceIdentifierFromSubscription calls. You can see a list of the --- event categories for a given SourceType in the Events topic in the Amazon --- RDS User Guide or by using the DescribeEventCategories action. +-- identifiers for a subscription, use the 'AddSourceIdentifierToSubscription' and 'RemoveSourceIdentifierFromSubscription' calls. -- +-- You can see a list of the event categories for a given SourceType in the topic in the Amazon RDS User Guide or by using the DescribeEventCategories +-- action. +-- -- module Network.AWS.RDS.ModifyEventSubscription ( @@ -90,26 +90,28 @@ mesEnabled :: Lens' ModifyEventSubscription (Maybe Bool) mesEnabled = lens _mesEnabled (\s a -> s { _mesEnabled = a }) --- | A list of event categories for a SourceType that you want to subscribe --- to. You can see a list of the categories for a given SourceType in the --- Events topic in the Amazon RDS User Guide or by using the --- DescribeEventCategories action. +-- | A list of event categories for a SourceType that you want to subscribe to. +-- You can see a list of the categories for a given SourceType in the +-- topic in the Amazon RDS User Guide or by using the DescribeEventCategories +-- action. mesEventCategories :: Lens' ModifyEventSubscription [Text] mesEventCategories = lens _mesEventCategories (\s a -> s { _mesEventCategories = a }) . _List -- | The Amazon Resource Name (ARN) of the SNS topic created for event --- notification. The ARN is created by Amazon SNS when you create a topic --- and subscribe to it. +-- notification. The ARN is created by Amazon SNS when you create a topic and +-- subscribe to it. mesSnsTopicArn :: Lens' ModifyEventSubscription (Maybe Text) mesSnsTopicArn = lens _mesSnsTopicArn (\s a -> s { _mesSnsTopicArn = a }) --- | The type of source that will be generating the events. For example, if --- you want to be notified of events generated by a DB instance, you would --- set this parameter to db-instance. if this value is not specified, all --- events are returned. Valid values: db-instance | db-parameter-group | --- db-security-group | db-snapshot. +-- | The type of source that will be generating the events. For example, if you +-- want to be notified of events generated by a DB instance, you would set this +-- parameter to db-instance. if this value is not specified, all events are +-- returned. +-- +-- Valid values: db-instance | db-parameter-group | db-security-group | +-- db-snapshot mesSourceType :: Lens' ModifyEventSubscription (Maybe Text) mesSourceType = lens _mesSourceType (\s a -> s { _mesSourceType = a }) diff --git a/gen/Network/AWS/RDS/ModifyOptionGroup.hs b/gen/Network/AWS/RDS/ModifyOptionGroup.hs --- a/gen/Network/AWS/RDS/ModifyOptionGroup.hs +++ b/gen/Network/AWS/RDS/ModifyOptionGroup.hs @@ -76,24 +76,23 @@ , _mogApplyImmediately = Nothing } --- | Indicates whether the changes should be applied immediately, or during --- the next maintenance window for each instance associated with the option --- group. +-- | Indicates whether the changes should be applied immediately, or during the +-- next maintenance window for each instance associated with the option group. mogApplyImmediately :: Lens' ModifyOptionGroup (Maybe Bool) mogApplyImmediately = lens _mogApplyImmediately (\s a -> s { _mogApplyImmediately = a }) --- | The name of the option group to be modified. Permanent options, such as --- the TDE option for Oracle Advanced Security TDE, cannot be removed from --- an option group, and that option group cannot be removed from a DB --- instance once it is associated with a DB instance. +-- | The name of the option group to be modified. +-- +-- Permanent options, such as the TDE option for Oracle Advanced Security TDE, +-- cannot be removed from an option group, and that option group cannot be +-- removed from a DB instance once it is associated with a DB instance mogOptionGroupName :: Lens' ModifyOptionGroup Text mogOptionGroupName = lens _mogOptionGroupName (\s a -> s { _mogOptionGroupName = a }) --- | Options in this list are added to the option group or, if already --- present, the specified configuration is used to update the existing --- configuration. +-- | Options in this list are added to the option group or, if already present, +-- the specified configuration is used to update the existing configuration. mogOptionsToInclude :: Lens' ModifyOptionGroup [OptionConfiguration] mogOptionsToInclude = lens _mogOptionsToInclude (\s a -> s { _mogOptionsToInclude = a }) diff --git a/gen/Network/AWS/RDS/PromoteReadReplica.hs b/gen/Network/AWS/RDS/PromoteReadReplica.hs --- a/gen/Network/AWS/RDS/PromoteReadReplica.hs +++ b/gen/Network/AWS/RDS/PromoteReadReplica.hs @@ -71,29 +71,40 @@ , _prrPreferredBackupWindow = Nothing } --- | The number of days to retain automated backups. Setting this parameter to --- a positive number enables backups. Setting this parameter to 0 disables --- automated backups. Default: 1 Constraints: Must be a value from 0 to 8. +-- | The number of days to retain automated backups. Setting this parameter to a +-- positive number enables backups. Setting this parameter to 0 disables +-- automated backups. +-- +-- Default: 1 +-- +-- Constraints: +-- +-- Must be a value from 0 to 8 prrBackupRetentionPeriod :: Lens' PromoteReadReplica (Maybe Int) prrBackupRetentionPeriod = lens _prrBackupRetentionPeriod (\s a -> s { _prrBackupRetentionPeriod = a }) -- | The DB instance identifier. This value is stored as a lowercase string. --- Constraints: Must be the identifier for an existing read replica DB --- instance Must contain from 1 to 63 alphanumeric characters or hyphens --- First character must be a letter Cannot end with a hyphen or contain two --- consecutive hyphens Example: mydbinstance. +-- +-- Constraints: +-- +-- Must be the identifier for an existing read replica DB instance Must +-- contain from 1 to 63 alphanumeric characters or hyphens First character must +-- be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: +-- mydbinstance prrDBInstanceIdentifier :: Lens' PromoteReadReplica Text prrDBInstanceIdentifier = lens _prrDBInstanceIdentifier (\s a -> s { _prrDBInstanceIdentifier = a }) --- | The daily time range during which automated backups are created if --- automated backups are enabled, using the BackupRetentionPeriod parameter. --- Default: A 30-minute window selected at random from an 8-hour block of --- time per region. See the Amazon RDS User Guide for the time blocks for --- each region from which the default backup windows are assigned. --- Constraints: Must be in the format hh24:mi-hh24:mi. Times should be +-- | The daily time range during which automated backups are created if automated +-- backups are enabled, using the 'BackupRetentionPeriod' parameter. +-- +-- Default: A 30-minute window selected at random from an 8-hour block of time +-- per region. See the Amazon RDS User Guide for the time blocks for each region +-- from which the default backup windows are assigned. +-- +-- Constraints: Must be in the format 'hh24:mi-hh24:mi'. Times should be -- Universal Time Coordinated (UTC). Must not conflict with the preferred -- maintenance window. Must be at least 30 minutes. prrPreferredBackupWindow :: Lens' PromoteReadReplica (Maybe Text) diff --git a/gen/Network/AWS/RDS/PurchaseReservedDBInstancesOffering.hs b/gen/Network/AWS/RDS/PurchaseReservedDBInstancesOffering.hs --- a/gen/Network/AWS/RDS/PurchaseReservedDBInstancesOffering.hs +++ b/gen/Network/AWS/RDS/PurchaseReservedDBInstancesOffering.hs @@ -76,20 +76,24 @@ , _prdbioTags = mempty } --- | The number of instances to reserve. Default: 1. +-- | The number of instances to reserve. +-- +-- Default: '1' prdbioDBInstanceCount :: Lens' PurchaseReservedDBInstancesOffering (Maybe Int) prdbioDBInstanceCount = lens _prdbioDBInstanceCount (\s a -> s { _prdbioDBInstanceCount = a }) --- | Customer-specified identifier to track this reservation. Example: --- myreservationID. +-- | Customer-specified identifier to track this reservation. +-- +-- Example: myreservationID prdbioReservedDBInstanceId :: Lens' PurchaseReservedDBInstancesOffering (Maybe Text) prdbioReservedDBInstanceId = lens _prdbioReservedDBInstanceId (\s a -> s { _prdbioReservedDBInstanceId = a }) --- | The ID of the Reserved DB instance offering to purchase. Example: --- 438012d3-4052-4cc7-b2e3-8d3372e0e706. +-- | The ID of the Reserved DB instance offering to purchase. +-- +-- Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 prdbioReservedDBInstancesOfferingId :: Lens' PurchaseReservedDBInstancesOffering Text prdbioReservedDBInstancesOfferingId = lens _prdbioReservedDBInstancesOfferingId diff --git a/gen/Network/AWS/RDS/RebootDBInstance.hs b/gen/Network/AWS/RDS/RebootDBInstance.hs --- a/gen/Network/AWS/RDS/RebootDBInstance.hs +++ b/gen/Network/AWS/RDS/RebootDBInstance.hs @@ -24,18 +24,20 @@ -- applies to the DB instance any modifications to the associated DB parameter -- group that were pending. Rebooting a DB instance results in a momentary -- outage of the instance, during which the DB instance status is set to --- rebooting. If the RDS instance is configured for MultiAZ, it is possible --- that the reboot will be conducted through a failover. An Amazon RDS event --- is created when the reboot is completed. If your DB instance is deployed in --- multiple Availability Zones, you can force a failover from one AZ to the --- other during the reboot. You might force a failover to test the --- availability of your DB instance deployment or to restore operations to the --- original AZ after a failover occurs. The time required to reboot is a --- function of the specific database engine's crash recovery process. To --- improve the reboot time, we recommend that you reduce database activities --- as much as possible during the reboot process to reduce rollback activity --- for in-transit transactions. +-- rebooting. If the RDS instance is configured for MultiAZ, it is possible that +-- the reboot will be conducted through a failover. An Amazon RDS event is +-- created when the reboot is completed. -- +-- If your DB instance is deployed in multiple Availability Zones, you can +-- force a failover from one AZ to the other during the reboot. You might force +-- a failover to test the availability of your DB instance deployment or to +-- restore operations to the original AZ after a failover occurs. +-- +-- The time required to reboot is a function of the specific database engine's +-- crash recovery process. To improve the reboot time, we recommend that you +-- reduce database activities as much as possible during the reboot process to +-- reduce rollback activity for in-transit transactions. +-- -- module Network.AWS.RDS.RebootDBInstance ( @@ -80,17 +82,21 @@ , _rdbiForceFailover = Nothing } --- | The DB instance identifier. This parameter is stored as a lowercase --- string. Constraints: Must contain from 1 to 63 alphanumeric characters or --- hyphens First character must be a letter Cannot end with a hyphen or --- contain two consecutive hyphens. +-- | The DB instance identifier. This parameter is stored as a lowercase string. +-- +-- Constraints: +-- +-- Must contain from 1 to 63 alphanumeric characters or hyphens First +-- character must be a letter Cannot end with a hyphen or contain two +-- consecutive hyphens rdbiDBInstanceIdentifier :: Lens' RebootDBInstance Text rdbiDBInstanceIdentifier = lens _rdbiDBInstanceIdentifier (\s a -> s { _rdbiDBInstanceIdentifier = a }) --- | When true, the reboot will be conducted through a MultiAZ failover. --- Constraint: You cannot specify true if the instance is not configured for +-- | When 'true', the reboot will be conducted through a MultiAZ failover. +-- +-- Constraint: You cannot specify 'true' if the instance is not configured for -- MultiAZ. rdbiForceFailover :: Lens' RebootDBInstance (Maybe Bool) rdbiForceFailover = diff --git a/gen/Network/AWS/RDS/RemoveTagsFromResource.hs b/gen/Network/AWS/RDS/RemoveTagsFromResource.hs --- a/gen/Network/AWS/RDS/RemoveTagsFromResource.hs +++ b/gen/Network/AWS/RDS/RemoveTagsFromResource.hs @@ -20,9 +20,10 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Removes metadata tags from an Amazon RDS resource. For an overview on --- tagging an Amazon RDS resource, see Tagging Amazon RDS Resources. +-- | Removes metadata tags from an Amazon RDS resource. -- +-- For an overview on tagging an Amazon RDS resource, see . +-- -- module Network.AWS.RDS.RemoveTagsFromResource ( @@ -66,8 +67,7 @@ } -- | The Amazon RDS resource the tags will be removed from. This value is an --- Amazon Resource Name (ARN). For information about creating an ARN, see --- Constructing an RDS Amazon Resource Name (ARN). +-- Amazon Resource Name (ARN). For information about creating an ARN, see . rtfrResourceName :: Lens' RemoveTagsFromResource Text rtfrResourceName = lens _rtfrResourceName (\s a -> s { _rtfrResourceName = a }) diff --git a/gen/Network/AWS/RDS/ResetDBParameterGroup.hs b/gen/Network/AWS/RDS/ResetDBParameterGroup.hs --- a/gen/Network/AWS/RDS/ResetDBParameterGroup.hs +++ b/gen/Network/AWS/RDS/ResetDBParameterGroup.hs @@ -20,13 +20,9 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Modifies the parameters of a DB parameter group to the engine/system --- default value. To reset specific parameters submit a list of the following: --- ParameterName and ApplyMethod. To reset the entire DB parameter group, --- specify the DBParameterGroup name and ResetAllParameters parameters. When --- resetting the entire group, dynamic parameters are updated immediately and --- static parameters are set to pending-reboot to take effect on the next DB --- instance restart or RebootDBInstance request. +-- | Modifies the parameters of a DB parameter group to the engine/system default +-- value. To reset specific parameters submit a list of the following: 'ParameterName' and 'ApplyMethod'. To reset the entire DB parameter group, specify the 'DBParameterGroup' name and 'ResetAllParameters' parameters. When resetting the entire group, +-- dynamic parameters are updated immediately and static parameters are set to 'pending-reboot' to take effect on the next DB instance restart or 'RebootDBInstance' request. -- -- module Network.AWS.RDS.ResetDBParameterGroup @@ -77,27 +73,40 @@ , _rdbpgParameters = mempty } --- | The name of the DB 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. +-- | The name of the DB 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 +-- rdbpgDBParameterGroupName :: Lens' ResetDBParameterGroup Text rdbpgDBParameterGroupName = lens _rdbpgDBParameterGroupName (\s a -> s { _rdbpgDBParameterGroupName = a }) --- | An array of parameter names, values, and the apply method for the --- parameter update. At least one parameter name, value, and apply method --- must be supplied; subsequent arguments are optional. A maximum of 20 --- parameters may be modified in a single request. MySQL Valid Values (for --- Apply method): immediate | pending-reboot You can use the immediate value --- with dynamic parameters only. You can use the pending-reboot value for --- both dynamic and static parameters, and changes are applied when DB --- instance reboots. Oracle Valid Values (for Apply method): pending-reboot. +-- | An array of parameter names, values, and the apply method for the parameter +-- update. At least one parameter name, value, and apply method must be +-- supplied; subsequent arguments are optional. A maximum of 20 parameters may +-- be modified in a single request. +-- +-- MySQL +-- +-- Valid Values (for Apply method): 'immediate' | 'pending-reboot' +-- +-- You can use the immediate value with dynamic parameters only. You can use +-- the 'pending-reboot' value for both dynamic and static parameters, and changes +-- are applied when DB instance reboots. +-- +-- Oracle +-- +-- Valid Values (for Apply method): 'pending-reboot' rdbpgParameters :: Lens' ResetDBParameterGroup [Parameter] rdbpgParameters = lens _rdbpgParameters (\s a -> s { _rdbpgParameters = a }) . _List --- | Specifies whether (true) or not (false) to reset all parameters in the DB --- parameter group to default values. Default: true. +-- | Specifies whether ('true') or not ('false') to reset all parameters in the DB +-- parameter group to default values. +-- +-- Default: 'true' rdbpgResetAllParameters :: Lens' ResetDBParameterGroup (Maybe Bool) rdbpgResetAllParameters = lens _rdbpgResetAllParameters (\s a -> s { _rdbpgResetAllParameters = a }) diff --git a/gen/Network/AWS/RDS/RestoreDBInstanceFromDBSnapshot.hs b/gen/Network/AWS/RDS/RestoreDBInstanceFromDBSnapshot.hs --- a/gen/Network/AWS/RDS/RestoreDBInstanceFromDBSnapshot.hs +++ b/gen/Network/AWS/RDS/RestoreDBInstanceFromDBSnapshot.hs @@ -20,10 +20,10 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Creates a new DB instance from a DB snapshot. The target database is --- created from the source database restore point with the same configuration --- as the original source database, except that the new RDS instance is --- created with the default security group. +-- | Creates a new DB instance from a DB snapshot. The target database is created +-- from the source database restore point with the same configuration as the +-- original source database, except that the new RDS instance is created with +-- the default security group. -- -- module Network.AWS.RDS.RestoreDBInstanceFromDBSnapshot @@ -150,37 +150,41 @@ , _rdbifdbsTdeCredentialPassword = Nothing } --- | Indicates that minor version upgrades will be applied automatically to --- the DB instance during the maintenance window. +-- | Indicates that minor version upgrades will be applied automatically to the +-- DB instance during the maintenance window. rdbifdbsAutoMinorVersionUpgrade :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) rdbifdbsAutoMinorVersionUpgrade = lens _rdbifdbsAutoMinorVersionUpgrade (\s a -> s { _rdbifdbsAutoMinorVersionUpgrade = a }) -- | The EC2 Availability Zone that the database instance will be created in. --- Default: A random, system-chosen Availability Zone. Constraint: You --- cannot specify the AvailabilityZone parameter if the MultiAZ parameter is --- set to true. Example: us-east-1a. +-- +-- Default: A random, system-chosen Availability Zone. +-- +-- Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ +-- parameter is set to 'true'. +-- +-- Example: 'us-east-1a' rdbifdbsAvailabilityZone :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) rdbifdbsAvailabilityZone = lens _rdbifdbsAvailabilityZone (\s a -> s { _rdbifdbsAvailabilityZone = a }) --- | The compute and memory capacity of the Amazon RDS DB instance. Valid --- Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | --- db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large --- | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | --- db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small --- | db.t2.medium. +-- | The compute and memory capacity of the Amazon RDS DB instance. +-- +-- Valid Values: 'db.t1.micro | db.m1.small | db.m1.medium | db.m1.large |db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large |db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge |db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium' rdbifdbsDBInstanceClass :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) rdbifdbsDBInstanceClass = lens _rdbifdbsDBInstanceClass (\s a -> s { _rdbifdbsDBInstanceClass = a }) --- | Name of the DB instance to create from the DB snapshot. This parameter --- isn't case sensitive. Constraints: Must contain from 1 to 255 --- alphanumeric characters or hyphens First character must be a letter --- Cannot end with a hyphen or contain two consecutive hyphens Example: --- my-snapshot-id. +-- | Name of the DB instance to create from the DB snapshot. This parameter isn't +-- case sensitive. +-- +-- Constraints: +-- +-- Must contain from 1 to 255 alphanumeric characters or hyphens First +-- character must be a letter Cannot end with a hyphen or contain two +-- consecutive hyphens Example: 'my-snapshot-id' rdbifdbsDBInstanceIdentifier :: Lens' RestoreDBInstanceFromDBSnapshot Text rdbifdbsDBInstanceIdentifier = lens _rdbifdbsDBInstanceIdentifier @@ -190,10 +194,13 @@ rdbifdbsDBName :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) rdbifdbsDBName = lens _rdbifdbsDBName (\s a -> s { _rdbifdbsDBName = a }) --- | The identifier for the DB snapshot to restore from. Constraints: Must --- contain from 1 to 63 alphanumeric characters or hyphens First character --- must be a letter Cannot end with a hyphen or contain two consecutive --- hyphens. +-- | The identifier for the DB snapshot to restore from. +-- +-- Constraints: +-- +-- Must contain from 1 to 63 alphanumeric characters or hyphens First +-- character must be a letter Cannot end with a hyphen or contain two +-- consecutive hyphens rdbifdbsDBSnapshotIdentifier :: Lens' RestoreDBInstanceFromDBSnapshot Text rdbifdbsDBSnapshotIdentifier = lens _rdbifdbsDBSnapshotIdentifier @@ -205,70 +212,87 @@ lens _rdbifdbsDBSubnetGroupName (\s a -> s { _rdbifdbsDBSubnetGroupName = a }) --- | The database engine to use for the new instance. Default: The same as --- source Constraint: Must be compatible with the engine of the source --- Example: oracle-ee. +-- | The database engine to use for the new instance. +-- +-- Default: The same as source +-- +-- Constraint: Must be compatible with the engine of the source +-- +-- Example: 'oracle-ee' rdbifdbsEngine :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) rdbifdbsEngine = lens _rdbifdbsEngine (\s a -> s { _rdbifdbsEngine = a }) --- | Specifies the amount of provisioned IOPS for the DB instance, expressed --- in I/O operations per second. If this parameter is not specified, the --- IOPS value will be taken from the backup. If this parameter is set to 0, --- the new instance will be converted to a non-PIOPS instance, which will --- take additional time, though your DB instance will be available for --- connections before the conversion starts. Constraints: Must be an integer --- greater than 1000. SQL Server Setting the IOPS value for the SQL Server --- database engine is not supported. +-- | Specifies the amount of provisioned IOPS for the DB instance, expressed in +-- I/O operations per second. If this parameter is not specified, the IOPS value +-- will be taken from the backup. If this parameter is set to 0, the new +-- instance will be converted to a non-PIOPS instance, which will take +-- additional time, though your DB instance will be available for connections +-- before the conversion starts. +-- +-- Constraints: Must be an integer greater than 1000. +-- +-- SQL Server +-- +-- Setting the IOPS value for the SQL Server database engine is not supported. rdbifdbsIops :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Int) rdbifdbsIops = lens _rdbifdbsIops (\s a -> s { _rdbifdbsIops = a }) --- | License model information for the restored DB instance. Default: Same as --- source. Valid values: license-included | bring-your-own-license | --- general-public-license. +-- | License model information for the restored DB instance. +-- +-- Default: Same as source. +-- +-- Valid values: 'license-included' | 'bring-your-own-license' | 'general-public-license' rdbifdbsLicenseModel :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) rdbifdbsLicenseModel = lens _rdbifdbsLicenseModel (\s a -> s { _rdbifdbsLicenseModel = a }) --- | Specifies if the DB instance is a Multi-AZ deployment. Constraint: You --- cannot specify the AvailabilityZone parameter if the MultiAZ parameter is --- set to true. +-- | Specifies if the DB instance is a Multi-AZ deployment. +-- +-- Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ +-- parameter is set to 'true'. rdbifdbsMultiAZ :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) rdbifdbsMultiAZ = lens _rdbifdbsMultiAZ (\s a -> s { _rdbifdbsMultiAZ = a }) -- | The name of the option group to be used for the restored DB instance. --- Permanent options, such as the TDE option for Oracle Advanced Security --- TDE, cannot be removed from an option group, and that option group cannot --- be removed from a DB instance once it is associated with a DB instance. +-- +-- Permanent options, such as the TDE option for Oracle Advanced Security TDE, +-- cannot be removed from an option group, and that option group cannot be +-- removed from a DB instance once it is associated with a DB instance rdbifdbsOptionGroupName :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) rdbifdbsOptionGroupName = lens _rdbifdbsOptionGroupName (\s a -> s { _rdbifdbsOptionGroupName = a }) --- | The port number on which the database accepts connections. Default: The --- same port as the original DB instance Constraints: Value must be --- 1150-65535. +-- | The port number on which the database accepts connections. +-- +-- Default: The same port as the original DB instance +-- +-- Constraints: Value must be '1150-65535' rdbifdbsPort :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Int) rdbifdbsPort = lens _rdbifdbsPort (\s a -> s { _rdbifdbsPort = a }) -- | 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 +-- 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 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. +-- been set, the DB instance will be private. rdbifdbsPubliclyAccessible :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Bool) rdbifdbsPubliclyAccessible = lens _rdbifdbsPubliclyAccessible (\s a -> s { _rdbifdbsPubliclyAccessible = a }) --- | Specifies storage type to be associated with the DB Instance. Valid --- values: standard | gp2 | io1 If you specify io1, you must also include a --- value for the Iops parameter. +-- | Specifies storage type to be associated with the DB Instance. +-- +-- Valid values: 'standard | gp2 | io1' +-- +-- If you specify 'io1', you must also include a value for the 'Iops' parameter. rdbifdbsStorageType :: Lens' RestoreDBInstanceFromDBSnapshot (Maybe Text) rdbifdbsStorageType = lens _rdbifdbsStorageType (\s a -> s { _rdbifdbsStorageType = a }) diff --git a/gen/Network/AWS/RDS/RestoreDBInstanceToPointInTime.hs b/gen/Network/AWS/RDS/RestoreDBInstanceToPointInTime.hs --- a/gen/Network/AWS/RDS/RestoreDBInstanceToPointInTime.hs +++ b/gen/Network/AWS/RDS/RestoreDBInstanceToPointInTime.hs @@ -23,8 +23,8 @@ -- | Restores a DB instance to an arbitrary point-in-time. Users can restore to -- any point in time before the latestRestorableTime for up to -- backupRetentionPeriod days. The target database is created from the source --- database with the same configuration as the original database except that --- the DB instance is created with the default DB security group. +-- database with the same configuration as the original database except that the +-- DB instance is created with the default DB security group. -- -- module Network.AWS.RDS.RestoreDBInstanceToPointInTime @@ -81,7 +81,7 @@ , _rdbitpitOptionGroupName :: Maybe Text , _rdbitpitPort :: Maybe Int , _rdbitpitPubliclyAccessible :: Maybe Bool - , _rdbitpitRestoreTime :: Maybe RFC822 + , _rdbitpitRestoreTime :: Maybe ISO8601 , _rdbitpitSourceDBInstanceIdentifier :: Text , _rdbitpitStorageType :: Maybe Text , _rdbitpitTags :: List "Tag" Tag @@ -161,29 +161,31 @@ , _rdbitpitTdeCredentialPassword = Nothing } --- | Indicates that minor version upgrades will be applied automatically to --- the DB instance during the maintenance window. +-- | Indicates that minor version upgrades will be applied automatically to the +-- DB instance during the maintenance window. rdbitpitAutoMinorVersionUpgrade :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) rdbitpitAutoMinorVersionUpgrade = lens _rdbitpitAutoMinorVersionUpgrade (\s a -> s { _rdbitpitAutoMinorVersionUpgrade = a }) -- | The EC2 Availability Zone that the database instance will be created in. --- Default: A random, system-chosen Availability Zone. Constraint: You --- cannot specify the AvailabilityZone parameter if the MultiAZ parameter is --- set to true. Example: us-east-1a. +-- +-- Default: A random, system-chosen Availability Zone. +-- +-- Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ +-- parameter is set to true. +-- +-- Example: 'us-east-1a' rdbitpitAvailabilityZone :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) rdbitpitAvailabilityZone = lens _rdbitpitAvailabilityZone (\s a -> s { _rdbitpitAvailabilityZone = a }) --- | The compute and memory capacity of the Amazon RDS DB instance. Valid --- Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | --- db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large --- | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | --- db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small --- | db.t2.medium Default: The same DBInstanceClass as the original DB --- instance. +-- | The compute and memory capacity of the Amazon RDS DB instance. +-- +-- Valid Values: 'db.t1.micro | db.m1.small | db.m1.medium | db.m1.large |db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large |db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge |db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium' +-- +-- Default: The same DBInstanceClass as the original DB instance. rdbitpitDBInstanceClass :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) rdbitpitDBInstanceClass = lens _rdbitpitDBInstanceClass (\s a -> s { _rdbitpitDBInstanceClass = a }) @@ -198,85 +200,108 @@ lens _rdbitpitDBSubnetGroupName (\s a -> s { _rdbitpitDBSubnetGroupName = a }) --- | The database engine to use for the new instance. Default: The same as --- source Constraint: Must be compatible with the engine of the source --- Example: oracle-ee. +-- | The database engine to use for the new instance. +-- +-- Default: The same as source +-- +-- Constraint: Must be compatible with the engine of the source +-- +-- Example: 'oracle-ee' rdbitpitEngine :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) rdbitpitEngine = lens _rdbitpitEngine (\s a -> s { _rdbitpitEngine = a }) -- | The amount of Provisioned IOPS (input/output operations per second) to be --- initially allocated for the DB instance. Constraints: Must be an integer --- greater than 1000. SQL Server Setting the IOPS value for the SQL Server --- database engine is not supported. +-- initially allocated for the DB instance. +-- +-- Constraints: Must be an integer greater than 1000. +-- +-- SQL Server +-- +-- Setting the IOPS value for the SQL Server database engine is not supported. rdbitpitIops :: Lens' RestoreDBInstanceToPointInTime (Maybe Int) rdbitpitIops = lens _rdbitpitIops (\s a -> s { _rdbitpitIops = a }) --- | License model information for the restored DB instance. Default: Same as --- source. Valid values: license-included | bring-your-own-license | --- general-public-license. +-- | License model information for the restored DB instance. +-- +-- Default: Same as source. +-- +-- Valid values: 'license-included' | 'bring-your-own-license' | 'general-public-license' rdbitpitLicenseModel :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) rdbitpitLicenseModel = lens _rdbitpitLicenseModel (\s a -> s { _rdbitpitLicenseModel = a }) --- | Specifies if the DB instance is a Multi-AZ deployment. Constraint: You --- cannot specify the AvailabilityZone parameter if the MultiAZ parameter is --- set to true. +-- | Specifies if the DB instance is a Multi-AZ deployment. +-- +-- Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ +-- parameter is set to 'true'. rdbitpitMultiAZ :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) rdbitpitMultiAZ = lens _rdbitpitMultiAZ (\s a -> s { _rdbitpitMultiAZ = a }) -- | The name of the option group to be used for the restored DB instance. --- Permanent options, such as the TDE option for Oracle Advanced Security --- TDE, cannot be removed from an option group, and that option group cannot --- be removed from a DB instance once it is associated with a DB instance. +-- +-- Permanent options, such as the TDE option for Oracle Advanced Security TDE, +-- cannot be removed from an option group, and that option group cannot be +-- removed from a DB instance once it is associated with a DB instance rdbitpitOptionGroupName :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) rdbitpitOptionGroupName = lens _rdbitpitOptionGroupName (\s a -> s { _rdbitpitOptionGroupName = a }) --- | The port number on which the database accepts connections. Constraints: --- Value must be 1150-65535 Default: The same port as the original DB --- instance. +-- | The port number on which the database accepts connections. +-- +-- Constraints: Value must be '1150-65535' +-- +-- Default: The same port as the original DB instance. rdbitpitPort :: Lens' RestoreDBInstanceToPointInTime (Maybe Int) rdbitpitPort = lens _rdbitpitPort (\s a -> s { _rdbitpitPort = a }) -- | 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 +-- 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 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. +-- been set, the DB instance will be private. rdbitpitPubliclyAccessible :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) rdbitpitPubliclyAccessible = lens _rdbitpitPubliclyAccessible (\s a -> s { _rdbitpitPubliclyAccessible = a }) --- | The date and time to restore from. Valid Values: Value must be a UTC time --- Constraints: Must be before the latest restorable time for the DB --- instance Cannot be specified if UseLatestRestorableTime parameter is true --- Example: 2009-09-07T23:45:00Z. +-- | The date and time to restore from. +-- +-- Valid Values: Value must be a UTC time +-- +-- Constraints: +-- +-- Must be before the latest restorable time for the DB instance Cannot be +-- specified if UseLatestRestorableTime parameter is true Example: '2009-09-07T23:45:00Z' rdbitpitRestoreTime :: Lens' RestoreDBInstanceToPointInTime (Maybe UTCTime) rdbitpitRestoreTime = lens _rdbitpitRestoreTime (\s a -> s { _rdbitpitRestoreTime = a }) . mapping _Time -- | The identifier of the source DB instance from which to restore. --- Constraints: Must be the identifier of an existing database instance Must --- contain from 1 to 63 alphanumeric characters or hyphens First character --- must be a letter Cannot end with a hyphen or contain two consecutive --- hyphens. +-- +-- Constraints: +-- +-- Must be the identifier of an existing database instance Must contain from 1 +-- to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens +-- rdbitpitSourceDBInstanceIdentifier :: Lens' RestoreDBInstanceToPointInTime Text rdbitpitSourceDBInstanceIdentifier = lens _rdbitpitSourceDBInstanceIdentifier (\s a -> s { _rdbitpitSourceDBInstanceIdentifier = a }) --- | Specifies storage type to be associated with the DB Instance. Valid --- values: standard | gp2 | io1 If you specify io1, you must also include a --- value for the Iops parameter. +-- | Specifies storage type to be associated with the DB Instance. +-- +-- Valid values: 'standard | gp2 | io1' +-- +-- If you specify 'io1', you must also include a value for the 'Iops' parameter. rdbitpitStorageType :: Lens' RestoreDBInstanceToPointInTime (Maybe Text) rdbitpitStorageType = lens _rdbitpitStorageType (\s a -> s { _rdbitpitStorageType = a }) @@ -284,10 +309,13 @@ rdbitpitTags :: Lens' RestoreDBInstanceToPointInTime [Tag] rdbitpitTags = lens _rdbitpitTags (\s a -> s { _rdbitpitTags = a }) . _List --- | The name of the new database instance to be created. Constraints: Must --- contain from 1 to 63 alphanumeric characters or hyphens First character --- must be a letter Cannot end with a hyphen or contain two consecutive --- hyphens. +-- | The name of the new database instance to be created. +-- +-- Constraints: +-- +-- Must contain from 1 to 63 alphanumeric characters or hyphens First +-- character must be a letter Cannot end with a hyphen or contain two +-- consecutive hyphens rdbitpitTargetDBInstanceIdentifier :: Lens' RestoreDBInstanceToPointInTime Text rdbitpitTargetDBInstanceIdentifier = lens _rdbitpitTargetDBInstanceIdentifier @@ -307,9 +335,12 @@ lens _rdbitpitTdeCredentialPassword (\s a -> s { _rdbitpitTdeCredentialPassword = a }) --- | Specifies whether (true) or not (false) the DB instance is restored from --- the latest backup time. Default: false Constraints: Cannot be specified --- if RestoreTime parameter is provided. +-- | Specifies whether ('true') or not ('false') the DB instance is restored from the +-- latest backup time. +-- +-- Default: 'false' +-- +-- Constraints: Cannot be specified if RestoreTime parameter is provided. rdbitpitUseLatestRestorableTime :: Lens' RestoreDBInstanceToPointInTime (Maybe Bool) rdbitpitUseLatestRestorableTime = lens _rdbitpitUseLatestRestorableTime diff --git a/gen/Network/AWS/RDS/RevokeDBSecurityGroupIngress.hs b/gen/Network/AWS/RDS/RevokeDBSecurityGroupIngress.hs --- a/gen/Network/AWS/RDS/RevokeDBSecurityGroupIngress.hs +++ b/gen/Network/AWS/RDS/RevokeDBSecurityGroupIngress.hs @@ -84,9 +84,8 @@ , _rdbsgiEC2SecurityGroupOwnerId = Nothing } --- | The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP --- is specified, EC2SecurityGroupName, EC2SecurityGroupId and --- EC2SecurityGroupOwnerId cannot be provided. +-- | The IP range to revoke access from. Must be a valid CIDR range. If 'CIDRIP' is +-- specified, 'EC2SecurityGroupName', 'EC2SecurityGroupId' and 'EC2SecurityGroupOwnerId' cannot be provided. rdbsgiCIDRIP :: Lens' RevokeDBSecurityGroupIngress (Maybe Text) rdbsgiCIDRIP = lens _rdbsgiCIDRIP (\s a -> s { _rdbsgiCIDRIP = a }) @@ -96,29 +95,29 @@ lens _rdbsgiDBSecurityGroupName (\s a -> s { _rdbsgiDBSecurityGroupName = a }) --- | The id of the EC2 security group to revoke access from. For VPC DB --- security groups, EC2SecurityGroupId must be provided. Otherwise, --- EC2SecurityGroupOwnerId and either EC2SecurityGroupName or --- EC2SecurityGroupId must be provided. +-- | The id of the EC2 security group to revoke access from. For VPC DB security +-- groups, 'EC2SecurityGroupId' must be provided. Otherwise, +-- EC2SecurityGroupOwnerId and either 'EC2SecurityGroupName' or 'EC2SecurityGroupId' +-- must be provided. rdbsgiEC2SecurityGroupId :: Lens' RevokeDBSecurityGroupIngress (Maybe Text) rdbsgiEC2SecurityGroupId = lens _rdbsgiEC2SecurityGroupId (\s a -> s { _rdbsgiEC2SecurityGroupId = a }) -- | The name of the EC2 security group to revoke access from. For VPC DB --- security groups, EC2SecurityGroupId must be provided. Otherwise, --- EC2SecurityGroupOwnerId and either EC2SecurityGroupName or --- EC2SecurityGroupId must be provided. +-- security groups, 'EC2SecurityGroupId' must be provided. Otherwise, +-- EC2SecurityGroupOwnerId and either 'EC2SecurityGroupName' or 'EC2SecurityGroupId' +-- must be provided. rdbsgiEC2SecurityGroupName :: Lens' RevokeDBSecurityGroupIngress (Maybe Text) rdbsgiEC2SecurityGroupName = lens _rdbsgiEC2SecurityGroupName (\s a -> s { _rdbsgiEC2SecurityGroupName = a }) --- | The AWS Account Number of the owner of the EC2 security group specified --- in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an --- acceptable value. For VPC DB security groups, EC2SecurityGroupId must be --- provided. Otherwise, EC2SecurityGroupOwnerId and either --- EC2SecurityGroupName or EC2SecurityGroupId must be provided. +-- | The AWS Account Number of the owner of the EC2 security group specified in +-- the 'EC2SecurityGroupName' parameter. The AWS Access Key ID is not an +-- acceptable value. For VPC DB security groups, 'EC2SecurityGroupId' must be +-- provided. Otherwise, EC2SecurityGroupOwnerId and either 'EC2SecurityGroupName' +-- or 'EC2SecurityGroupId' must be provided. rdbsgiEC2SecurityGroupOwnerId :: Lens' RevokeDBSecurityGroupIngress (Maybe Text) rdbsgiEC2SecurityGroupOwnerId = lens _rdbsgiEC2SecurityGroupOwnerId diff --git a/gen/Network/AWS/RDS/Types.hs b/gen/Network/AWS/RDS/Types.hs --- a/gen/Network/AWS/RDS/Types.hs +++ b/gen/Network/AWS/RDS/Types.hs @@ -478,9 +478,9 @@ , _ogVpcId = Nothing } --- | 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. +-- | 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. ogAllowsVpcAndNonVpcInstanceMemberships :: Lens' OptionGroup (Maybe Bool) ogAllowsVpcAndNonVpcInstanceMemberships = lens _ogAllowsVpcAndNonVpcInstanceMemberships @@ -510,11 +510,11 @@ ogOptions :: Lens' OptionGroup [Option] ogOptions = lens _ogOptions (\s a -> s { _ogOptions = a }) . _List --- | 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. +-- | 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. ogVpcId :: Lens' OptionGroup (Maybe Text) ogVpcId = lens _ogVpcId (\s a -> s { _ogVpcId = a }) @@ -582,7 +582,7 @@ ] data Event = Event - { _eDate :: Maybe RFC822 + { _eDate :: Maybe ISO8601 , _eEventCategories :: List "EventCategory" Text , _eMessage :: Maybe Text , _eSourceIdentifier :: Maybe Text @@ -696,13 +696,13 @@ dbsgDBSecurityGroupName = lens _dbsgDBSecurityGroupName (\s a -> s { _dbsgDBSecurityGroupName = a }) --- | Contains a list of EC2SecurityGroup elements. +-- | Contains a list of 'EC2SecurityGroup' elements. dbsgEC2SecurityGroups :: Lens' DBSecurityGroup [EC2SecurityGroup] dbsgEC2SecurityGroups = lens _dbsgEC2SecurityGroups (\s a -> s { _dbsgEC2SecurityGroups = a }) . _List --- | Contains a list of IPRange elements. +-- | Contains a list of 'IPRange' elements. dbsgIPRanges :: Lens' DBSecurityGroup [IPRange] dbsgIPRanges = lens _dbsgIPRanges (\s a -> s { _dbsgIPRanges = a }) . _List @@ -752,18 +752,18 @@ , _tagValue = Nothing } --- | 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: +-- | 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}_.:/=+\\-]*)$"). tagKey :: Lens' Tag (Maybe Text) tagKey = lens _tagKey (\s a -> s { _tagKey = a }) --- | 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: +-- | 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}_.:/=+\\-]*)$"). tagValue :: Lens' Tag (Maybe Text) tagValue = lens _tagValue (\s a -> s { _tagValue = a }) @@ -835,9 +835,7 @@ lens _dbevDBParameterGroupFamily (\s a -> s { _dbevDBParameterGroupFamily = a }) --- | The default character set for new instances of this engine version, if --- the CharacterSetName parameter of the CreateDBInstance API is not --- specified. +-- | The default character set for new instances of this engine version, if the 'CharacterSetName' parameter of the CreateDBInstance API is not specified. dbevDefaultCharacterSet :: Lens' DBEngineVersion (Maybe CharacterSet) dbevDefaultCharacterSet = lens _dbevDefaultCharacterSet (\s a -> s { _dbevDefaultCharacterSet = a }) @@ -851,8 +849,7 @@ dbevEngineVersion = lens _dbevEngineVersion (\s a -> s { _dbevEngineVersion = a }) --- | A list of the character sets supported by this engine for the --- CharacterSetName parameter of the CreateDBInstance API. +-- | A list of the character sets supported by this engine for the 'CharacterSetName' parameter of the CreateDBInstance API. dbevSupportedCharacterSets :: Lens' DBEngineVersion [CharacterSet] dbevSupportedCharacterSets = lens _dbevSupportedCharacterSets @@ -887,14 +884,14 @@ , _dbsDBSnapshotIdentifier :: Maybe Text , _dbsEngine :: Maybe Text , _dbsEngineVersion :: Maybe Text - , _dbsInstanceCreateTime :: Maybe RFC822 + , _dbsInstanceCreateTime :: Maybe ISO8601 , _dbsIops :: Maybe Int , _dbsLicenseModel :: Maybe Text , _dbsMasterUsername :: Maybe Text , _dbsOptionGroupName :: Maybe Text , _dbsPercentProgress :: Maybe Int , _dbsPort :: Maybe Int - , _dbsSnapshotCreateTime :: Maybe RFC822 + , _dbsSnapshotCreateTime :: Maybe ISO8601 , _dbsSnapshotType :: Maybe Text , _dbsSourceRegion :: Maybe Text , _dbsStatus :: Maybe Text @@ -976,14 +973,14 @@ dbsAllocatedStorage = lens _dbsAllocatedStorage (\s a -> s { _dbsAllocatedStorage = a }) --- | Specifies the name of the Availability Zone the DB instance was located --- in at the time of the DB snapshot. +-- | Specifies the name of the Availability Zone the DB instance was located in +-- at the time of the DB snapshot. dbsAvailabilityZone :: Lens' DBSnapshot (Maybe Text) dbsAvailabilityZone = lens _dbsAvailabilityZone (\s a -> s { _dbsAvailabilityZone = a }) --- | Specifies the DB instance identifier of the DB instance this DB snapshot --- was created from. +-- | Specifies the DB instance identifier of the DB instance this DB snapshot was +-- created from. dbsDBInstanceIdentifier :: Lens' DBSnapshot (Maybe Text) dbsDBInstanceIdentifier = lens _dbsDBInstanceIdentifier (\s a -> s { _dbsDBInstanceIdentifier = a }) @@ -1007,8 +1004,8 @@ lens _dbsInstanceCreateTime (\s a -> s { _dbsInstanceCreateTime = a }) . mapping _Time --- | Specifies the Provisioned IOPS (I/O operations per second) value of the --- DB instance at the time of the snapshot. +-- | Specifies the Provisioned IOPS (I/O operations per second) value of the DB +-- instance at the time of the snapshot. dbsIops :: Lens' DBSnapshot (Maybe Int) dbsIops = lens _dbsIops (\s a -> s { _dbsIops = a }) @@ -1031,8 +1028,8 @@ dbsPercentProgress = lens _dbsPercentProgress (\s a -> s { _dbsPercentProgress = a }) --- | Specifies the port that the database engine was listening on at the time --- of the snapshot. +-- | Specifies the port that the database engine was listening on at the time of +-- the snapshot. dbsPort :: Lens' DBSnapshot (Maybe Int) dbsPort = lens _dbsPort (\s a -> s { _dbsPort = a }) @@ -1193,15 +1190,14 @@ lens _ecsgEC2SecurityGroupName (\s a -> s { _ecsgEC2SecurityGroupName = a }) --- | Specifies the AWS ID of the owner of the EC2 security group specified in --- the EC2SecurityGroupName field. +-- | Specifies the AWS ID of the owner of the EC2 security group specified in the 'EC2SecurityGroupName' field. ecsgEC2SecurityGroupOwnerId :: Lens' EC2SecurityGroup (Maybe Text) ecsgEC2SecurityGroupOwnerId = lens _ecsgEC2SecurityGroupOwnerId (\s a -> s { _ecsgEC2SecurityGroupOwnerId = a }) --- | Provides the status of the EC2 security group. Status can be --- "authorizing", "authorized", "revoking", and "revoked". +-- | Provides the status of the EC2 security group. Status can be "authorizing", +-- "authorized", "revoking", and "revoked". ecsgStatus :: Lens' EC2SecurityGroup (Maybe Text) ecsgStatus = lens _ecsgStatus (\s a -> s { _ecsgStatus = a }) @@ -1230,10 +1226,13 @@ instance Hashable SourceType instance FromText SourceType where - parser = match "db-instance" DbInstance - <|> match "db-parameter-group" DbParameterGroup - <|> match "db-security-group" DbSecurityGroup - <|> match "db-snapshot" DbSnapshot + parser = takeText >>= \case + "db-instance" -> pure DbInstance + "db-parameter-group" -> pure DbParameterGroup + "db-security-group" -> pure DbSecurityGroup + "db-snapshot" -> pure DbSnapshot + e -> fail $ + "Failure parsing SourceType from " ++ show e instance ToText SourceType where toText = \case @@ -1249,7 +1248,6 @@ instance FromXML SourceType where parseXML = parseXMLText "SourceType" - data DBParameterGroup = DBParameterGroup { _dbpgDBParameterGroupFamily :: Maybe Text , _dbpgDBParameterGroupName :: Maybe Text @@ -1437,8 +1435,11 @@ instance Hashable ApplyMethod instance FromText ApplyMethod where - parser = match "immediate" Immediate - <|> match "pending-reboot" PendingReboot + parser = takeText >>= \case + "immediate" -> pure Immediate + "pending-reboot" -> pure PendingReboot + e -> fail $ + "Failure parsing ApplyMethod from " ++ show e instance ToText ApplyMethod where toText = \case @@ -1452,7 +1453,6 @@ instance FromXML ApplyMethod where parseXML = parseXMLText "ApplyMethod" - data CharacterSet = CharacterSet { _csCharacterSetDescription :: Maybe Text , _csCharacterSetName :: Maybe Text @@ -1555,7 +1555,7 @@ , _rdbiRecurringCharges :: List "RecurringCharge" RecurringCharge , _rdbiReservedDBInstanceId :: Maybe Text , _rdbiReservedDBInstancesOfferingId :: Maybe Text - , _rdbiStartTime :: Maybe RFC822 + , _rdbiStartTime :: Maybe ISO8601 , _rdbiState :: Maybe Text , _rdbiUsagePrice :: Maybe Double } deriving (Eq, Show) @@ -1733,16 +1733,16 @@ , _edParameters = mempty } --- | Specifies the name of the DB parameter group family which the engine --- default parameters apply to. +-- | Specifies the name of the DB parameter group family which the engine default +-- parameters apply to. edDBParameterGroupFamily :: Lens' EngineDefaults (Maybe Text) edDBParameterGroupFamily = lens _edDBParameterGroupFamily (\s a -> s { _edDBParameterGroupFamily = a }) --- | 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 . +-- | 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' . edMarker :: Lens' EngineDefaults (Maybe Text) edMarker = lens _edMarker (\s a -> s { _edMarker = a }) @@ -1875,8 +1875,8 @@ ogoName :: Lens' OptionGroupOption (Maybe Text) ogoName = lens _ogoName (\s a -> s { _ogoName = a }) --- | Specifies the option settings that are available (and the default value) --- for each option in an option group. +-- | Specifies the option settings that are available (and the default value) for +-- each option in an option group. ogoOptionGroupOptionSettings :: Lens' OptionGroupOption [OptionGroupOptionSetting] ogoOptionGroupOptionSettings = lens _ogoOptionGroupOptionSettings @@ -1889,16 +1889,16 @@ lens _ogoOptionsDependedOn (\s a -> s { _ogoOptionsDependedOn = a }) . _List --- | 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. +-- | 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. ogoPermanent :: Lens' OptionGroupOption (Maybe Bool) ogoPermanent = lens _ogoPermanent (\s a -> s { _ogoPermanent = a }) --- | 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. +-- | 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. ogoPersistent :: Lens' OptionGroupOption (Maybe Bool) ogoPersistent = lens _ogoPersistent (\s a -> s { _ogoPersistent = a }) @@ -1951,9 +1951,9 @@ , _dbiEndpoint :: Maybe Endpoint , _dbiEngine :: Maybe Text , _dbiEngineVersion :: Maybe Text - , _dbiInstanceCreateTime :: Maybe RFC822 + , _dbiInstanceCreateTime :: Maybe ISO8601 , _dbiIops :: Maybe Int - , _dbiLatestRestorableTime :: Maybe RFC822 + , _dbiLatestRestorableTime :: Maybe ISO8601 , _dbiLicenseModel :: Maybe Text , _dbiMasterUsername :: Maybe Text , _dbiMultiAZ :: Maybe Bool @@ -2089,14 +2089,12 @@ lens _dbiAutoMinorVersionUpgrade (\s a -> s { _dbiAutoMinorVersionUpgrade = a }) --- | Specifies the name of the Availability Zone the DB instance is located --- in. +-- | Specifies the name of the Availability Zone the DB instance is located in. dbiAvailabilityZone :: Lens' DBInstance (Maybe Text) dbiAvailabilityZone = lens _dbiAvailabilityZone (\s a -> s { _dbiAvailabilityZone = a }) --- | Specifies the number of days for which automatic DB snapshots are --- retained. +-- | Specifies the number of days for which automatic DB snapshots are retained. dbiBackupRetentionPeriod :: Lens' DBInstance (Maybe Int) dbiBackupRetentionPeriod = lens _dbiBackupRetentionPeriod @@ -2125,15 +2123,23 @@ dbiDBInstanceStatus = lens _dbiDBInstanceStatus (\s a -> s { _dbiDBInstanceStatus = a }) --- | 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. +-- | 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. dbiDBName :: Lens' DBInstance (Maybe Text) dbiDBName = lens _dbiDBName (\s a -> s { _dbiDBName = a }) @@ -2143,16 +2149,14 @@ lens _dbiDBParameterGroups (\s a -> s { _dbiDBParameterGroups = a }) . _List --- | Provides List of DB security group elements containing only --- DBSecurityGroup.Name and DBSecurityGroup.Status subelements. +-- | Provides List of DB security group elements containing only 'DBSecurityGroup.Name' and 'DBSecurityGroup.Status' subelements. dbiDBSecurityGroups :: Lens' DBInstance [DBSecurityGroupMembership] dbiDBSecurityGroups = lens _dbiDBSecurityGroups (\s a -> s { _dbiDBSecurityGroups = a }) . _List --- | Specifies information on the subnet group associated with the DB --- instance, including the name, description, and subnets in the subnet --- group. +-- | Specifies information on the subnet group associated with the DB instance, +-- including the name, description, and subnets in the subnet group. dbiDBSubnetGroup :: Lens' DBInstance (Maybe DBSubnetGroup) dbiDBSubnetGroup = lens _dbiDBSubnetGroup (\s a -> s { _dbiDBSubnetGroup = a }) @@ -2205,62 +2209,62 @@ (\s a -> s { _dbiOptionGroupMemberships = a }) . _List --- | Specifies that changes to the DB instance are pending. This element is --- only included when changes are pending. Specific changes are identified --- by subelements. +-- | Specifies that changes to the DB instance are pending. This element is only +-- included when changes are pending. Specific changes are identified by +-- subelements. dbiPendingModifiedValues :: Lens' DBInstance (Maybe PendingModifiedValues) dbiPendingModifiedValues = lens _dbiPendingModifiedValues (\s a -> s { _dbiPendingModifiedValues = a }) --- | Specifies the daily time range during which automated backups are created --- if automated backups are enabled, as determined by the --- BackupRetentionPeriod. +-- | Specifies the daily time range during which automated backups are created if +-- automated backups are enabled, as determined by the 'BackupRetentionPeriod'. dbiPreferredBackupWindow :: Lens' DBInstance (Maybe Text) dbiPreferredBackupWindow = lens _dbiPreferredBackupWindow (\s a -> s { _dbiPreferredBackupWindow = a }) --- | Specifies the weekly time range (in UTC) during which system maintenance --- can occur. +-- | Specifies the weekly time range (in UTC) during which system maintenance can +-- occur. dbiPreferredMaintenanceWindow :: Lens' DBInstance (Maybe Text) dbiPreferredMaintenanceWindow = lens _dbiPreferredMaintenanceWindow (\s a -> s { _dbiPreferredMaintenanceWindow = a }) -- | 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 +-- 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 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. +-- been set, the DB instance will be private. dbiPubliclyAccessible :: Lens' DBInstance (Maybe Bool) dbiPubliclyAccessible = lens _dbiPubliclyAccessible (\s a -> s { _dbiPubliclyAccessible = a }) --- | Contains one or more identifiers of the read replicas associated with --- this DB instance. +-- | Contains one or more identifiers of the read replicas associated with this +-- DB instance. dbiReadReplicaDBInstanceIdentifiers :: Lens' DBInstance [Text] dbiReadReplicaDBInstanceIdentifiers = lens _dbiReadReplicaDBInstanceIdentifiers (\s a -> s { _dbiReadReplicaDBInstanceIdentifiers = a }) . _List --- | Contains the identifier of the source DB instance if this DB instance is --- a read replica. +-- | Contains the identifier of the source DB instance if this DB instance is a +-- read replica. dbiReadReplicaSourceDBInstanceIdentifier :: Lens' DBInstance (Maybe Text) dbiReadReplicaSourceDBInstanceIdentifier = lens _dbiReadReplicaSourceDBInstanceIdentifier (\s a -> s { _dbiReadReplicaSourceDBInstanceIdentifier = a }) --- | If present, specifies the name of the secondary Availability Zone for a --- DB instance with multi-AZ support. +-- | If present, specifies the name of the secondary Availability Zone for a DB +-- instance with multi-AZ support. dbiSecondaryAvailabilityZone :: Lens' DBInstance (Maybe Text) dbiSecondaryAvailabilityZone = lens _dbiSecondaryAvailabilityZone @@ -2446,8 +2450,8 @@ esCustomerAwsId :: Lens' EventSubscription (Maybe Text) esCustomerAwsId = lens _esCustomerAwsId (\s a -> s { _esCustomerAwsId = a }) --- | A Boolean value indicating if the subscription is enabled. True indicates --- the subscription is enabled. +-- | A Boolean value indicating if the subscription is enabled. True indicates the +-- subscription is enabled. esEnabled :: Lens' EventSubscription (Maybe Bool) esEnabled = lens _esEnabled (\s a -> s { _esEnabled = a }) @@ -2469,12 +2473,16 @@ esSourceType :: Lens' EventSubscription (Maybe Text) esSourceType = lens _esSourceType (\s a -> s { _esSourceType = a }) --- | 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. +-- | 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. esStatus :: Lens' EventSubscription (Maybe Text) esStatus = lens _esStatus (\s a -> s { _esStatus = a }) @@ -2556,7 +2564,7 @@ dbsg1SubnetGroupStatus = lens _dbsg1SubnetGroupStatus (\s a -> s { _dbsg1SubnetGroupStatus = a }) --- | Contains a list of Subnet elements. +-- | Contains a list of 'Subnet' elements. dbsg1Subnets :: Lens' DBSubnetGroup [Subnet] dbsg1Subnets = lens _dbsg1Subnets (\s a -> s { _dbsg1Subnets = a }) . _List @@ -2608,22 +2616,22 @@ , _dbisiMessage = Nothing } --- | 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. +-- | 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. dbisiMessage :: Lens' DBInstanceStatusInfo (Maybe Text) dbisiMessage = lens _dbisiMessage (\s a -> s { _dbisiMessage = a }) --- | Boolean value that is true if the instance is operating normally, or --- false if the instance is in an error state. +-- | Boolean value that is true if the instance is operating normally, or false +-- if the instance is in an error state. dbisiNormal :: Lens' DBInstanceStatusInfo (Maybe Bool) dbisiNormal = lens _dbisiNormal (\s a -> s { _dbisiNormal = a }) --- | Status of the DB instance. For a StatusType of read replica, the values --- can be replicating, error, stopped, or terminated. +-- | Status of the DB instance. For a StatusType of read replica, the values can +-- be replicating, error, stopped, or terminated. dbisiStatus :: Lens' DBInstanceStatusInfo (Maybe Text) dbisiStatus = lens _dbisiStatus (\s a -> s { _dbisiStatus = a }) --- | This value is currently "read replication.". +-- | This value is currently "read replication." dbisiStatusType :: Lens' DBInstanceStatusInfo (Maybe Text) dbisiStatusType = lens _dbisiStatusType (\s a -> s { _dbisiStatusType = a }) @@ -2858,7 +2866,7 @@ lens _odbioAvailabilityZones (\s a -> s { _odbioAvailabilityZones = a }) . _List --- | The DB instance Class for the orderable DB instance. +-- | The DB instance Class for the orderable DB instance odbioDBInstanceClass :: Lens' OrderableDBInstanceOption (Maybe Text) odbioDBInstanceClass = lens _odbioDBInstanceClass (\s a -> s { _odbioDBInstanceClass = a }) @@ -3163,8 +3171,8 @@ , _oVpcSecurityGroupMemberships = mempty } --- | If the option requires access to a port, then this DB security group --- allows access to the port. +-- | If the option requires access to a port, then this DB security group allows +-- access to the port. oDBSecurityGroupMemberships :: Lens' Option [DBSecurityGroupMembership] oDBSecurityGroupMemberships = lens _oDBSecurityGroupMemberships @@ -3196,8 +3204,8 @@ oPort :: Lens' Option (Maybe Int) oPort = lens _oPort (\s a -> s { _oPort = a }) --- | If the option requires access to a port, then this VPC security group --- allows access to the port. +-- | If the option requires access to a port, then this VPC security group allows +-- access to the port. oVpcSecurityGroupMemberships :: Lens' Option [VpcSecurityGroupMembership] oVpcSecurityGroupMemberships = lens _oVpcSecurityGroupMemberships @@ -3325,13 +3333,13 @@ , _ecmEventCategories = mempty } --- | The event categories for the specified source type. +-- | The event categories for the specified source type ecmEventCategories :: Lens' EventCategoriesMap [Text] ecmEventCategories = lens _ecmEventCategories (\s a -> s { _ecmEventCategories = a }) . _List --- | The source type that the returned categories belong to. +-- | The source type that the returned categories belong to ecmSourceType :: Lens' EventCategoriesMap (Maybe Text) ecmSourceType = lens _ecmSourceType (\s a -> s { _ecmSourceType = a }) @@ -3397,7 +3405,7 @@ , _pmvStorageType = Nothing } --- | Contains the new AllocatedStorage size for the DB instance that will be +-- | Contains the new 'AllocatedStorage' size for the DB instance that will be -- applied or is in progress. pmvAllocatedStorage :: Lens' PendingModifiedValues (Maybe Int) pmvAllocatedStorage = @@ -3410,13 +3418,13 @@ lens _pmvBackupRetentionPeriod (\s a -> s { _pmvBackupRetentionPeriod = a }) --- | Contains the new DBInstanceClass for the DB instance that will be applied --- or is in progress. +-- | Contains the new 'DBInstanceClass' for the DB instance that will be applied or +-- is in progress. pmvDBInstanceClass :: Lens' PendingModifiedValues (Maybe Text) pmvDBInstanceClass = lens _pmvDBInstanceClass (\s a -> s { _pmvDBInstanceClass = a }) --- | Contains the new DBInstanceIdentifier for the DB instance that will be +-- | Contains the new 'DBInstanceIdentifier' for the DB instance that will be -- applied or is in progress. pmvDBInstanceIdentifier :: Lens' PendingModifiedValues (Maybe Text) pmvDBInstanceIdentifier = @@ -3431,8 +3439,8 @@ pmvIops :: Lens' PendingModifiedValues (Maybe Int) pmvIops = lens _pmvIops (\s a -> s { _pmvIops = a }) --- | Contains the pending or in-progress change of the master credentials for --- the DB instance. +-- | Contains the pending or in-progress change of the master credentials for the +-- DB instance. pmvMasterUserPassword :: Lens' PendingModifiedValues (Maybe Text) pmvMasterUserPassword = lens _pmvMasterUserPassword (\s a -> s { _pmvMasterUserPassword = a }) @@ -3587,9 +3595,9 @@ pDescription :: Lens' Parameter (Maybe Text) pDescription = lens _pDescription (\s a -> s { _pDescription = a }) --- | Indicates whether (true) or not (false) the parameter can be modified. --- Some parameters have security or operational implications that prevent --- them from being changed. +-- | Indicates whether ('true') or not ('false') the parameter can be modified. Some +-- parameters have security or operational implications that prevent them from +-- being changed. pIsModifiable :: Lens' Parameter (Maybe Bool) pIsModifiable = lens _pIsModifiable (\s a -> s { _pIsModifiable = a })