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

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.RDS

Contents

Description

Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a MySQL, PostgreSQL, Microsoft SQL Server, Oracle, or Aurora database server. This means the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces.

See: AWS API Reference

Synopsis

Service Configuration

rDS :: Service Source

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

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by RDS.

CertificateNotFoundFault

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

CertificateIdentifier does not refer to an existing certificate.

ReservedDBInstanceQuotaExceededFault

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

Request would exceed the user's DB Instance quota.

DBClusterSnapshotAlreadyExistsFault

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

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

AuthorizationQuotaExceededFault

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

DB security group authorization quota has been reached.

SourceNotFoundFault

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

The requested source could not be found.

InvalidDBParameterGroupStateFault

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

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

DBParameterGroupAlreadyExistsFault

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

A DB parameter group with the same name exists.

PointInTimeRestoreNotEnabledFault

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

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

DBParameterGroupQuotaExceededFault

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

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

ProvisionedIOPSNotAvailableInAZFault

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

Provisioned IOPS not available in the specified Availability Zone.

AuthorizationAlreadyExistsFault

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

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

InsufficientDBClusterCapacityFault

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

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

ReservedDBInstanceAlreadyExistsFault

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

User already has a reservation with the given identifier.

SubscriptionCategoryNotFoundFault

DBSubnetQuotaExceededFault

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

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

SubscriptionNotFoundFault

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

The subscription name does not exist.

InvalidSubnet

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

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

DBClusterNotFoundFault

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

DBClusterIdentifier does not refer to an existing DB cluster.

OptionGroupNotFoundFault

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

The specified option group could not be found.

DBLogFileNotFoundFault

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

LogFileName does not refer to an existing DB log file.

OptionGroupAlreadyExistsFault

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

The option group you are trying to create already exists.

DBClusterAlreadyExistsFault

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

User already has a DB cluster with the given identifier.

StorageTypeNotSupportedFault

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

StorageType specified cannot be associated with the DB Instance.

DBSecurityGroupQuotaExceededFault

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

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

DBSnapshotNotFoundFault

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

DBSnapshotIdentifier does not refer to an existing DB snapshot.

InvalidEventSubscriptionStateFault

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

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

KMSKeyNotAccessibleFault

OptionGroupQuotaExceededFault

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

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

DBSecurityGroupAlreadyExistsFault

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

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

SnapshotQuotaExceededFault

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

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

SNSTopicARNNotFoundFault

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

The SNS topic ARN does not exist.

DBClusterQuotaExceededFault

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

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

DBClusterParameterGroupNotFoundFault

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

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

DBSubnetGroupAlreadyExistsFault

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

DBSubnetGroupName is already used by an existing DB subnet group.

InstanceQuotaExceededFault

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

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

SNSNoAuthorizationFault

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

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

DBSecurityGroupNotFoundFault

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

DBSecurityGroupName does not refer to an existing DB security group.

DBSecurityGroupNotSupportedFault

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

A DB security group is not allowed for this action.

DomainNotFoundFault

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

Domain does not refer to an existing Active Directory Domain.

DBClusterSnapshotNotFoundFault

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

DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

ReservedDBInstancesOfferingNotFoundFault

InvalidDBSubnetGroupFault

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

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

InvalidDBSubnetStateFault

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

The DB subnet is not in the available state.

DBParameterGroupNotFoundFault

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

DBParameterGroupName does not refer to an existing DB parameter group.

SNSInvalidTopicFault

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

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

SubscriptionAlreadyExistFault

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

The supplied subscription name already exists.

InvalidDBClusterSnapshotStateFault

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

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

InsufficientDBInstanceCapacityFault

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

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

InvalidVPCNetworkStateFault

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

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

AuthorizationNotFoundFault

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

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

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

ReservedDBInstanceNotFoundFault

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

The specified reserved DB Instance not found.

DBSubnetGroupQuotaExceededFault

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

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

DBSubnetGroupNotAllowedFault

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

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

EventSubscriptionQuotaExceededFault

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

You have reached the maximum number of event subscriptions.

InvalidOptionGroupStateFault

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

The option group is not in the available state.

InvalidDBClusterStateFault

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

The supplied value is not a valid DB cluster state.

InsufficientStorageClusterCapacityFault

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

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

DBInstanceAlreadyExistsFault

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

User already has a DB instance with the given identifier.

ResourceNotFoundFault

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

The specified resource ID was not found.

DBUpgradeDependencyFailureFault

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

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

InvalidDBSecurityGroupStateFault

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

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

InsufficientDomainCapacityFault

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

Requested Active Directory Domain has reached maximum number of instances.

DBSubnetGroupNotFoundFault

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

DBSubnetGroupName does not refer to an existing DB subnet group.

InvalidRestoreFault

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

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

InvalidDBInstanceStateFault

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

The specified DB instance is not in the available state.

InvalidDBSnapshotStateFault

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

The state of the DB snapshot does not allow deletion.

InvalidDBSubnetGroupStateFault

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

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

StorageQuotaExceededFault

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

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

DBSnapshotAlreadyExistsFault

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

DBSnapshotIdentifier is already used by an existing snapshot.

DBInstanceNotFoundFault

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

DBInstanceIdentifier does not refer to an existing DB instance.

SubnetAlreadyInUse

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

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

DBSubnetGroupDoesNotCoverEnoughAZs

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

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

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

DBInstanceAvailable

dbInstanceAvailable :: Wait DescribeDBInstances Source

Polls DescribeDBInstances every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.

DBSnapshotCompleted

dbSnapshotCompleted :: Wait DescribeDBSnapshots Source

Polls DescribeDBSnapshots every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

DBInstanceDeleted

dbInstanceDeleted :: Wait DescribeDBInstances Source

Polls DescribeDBInstances every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DescribeDBEngineVersions (Paginated)

DescribeDBClusterParameterGroups

PromoteReadReplica

ModifyEventSubscription

CopyDBSnapshot

AddSourceIdentifierToSubscription

ModifyDBInstance

ResetDBClusterParameterGroup

DescribeEvents (Paginated)

DescribeEngineDefaultParameters (Paginated)

DescribeDBClusters

ModifyDBSubnetGroup

DescribeDBLogFiles (Paginated)

ListTagsForResource

DescribeOptionGroups (Paginated)

DeleteDBCluster

RemoveSourceIdentifierFromSubscription

CopyDBParameterGroup

DescribeReservedDBInstances (Paginated)

DeleteOptionGroup

DescribeEngineDefaultClusterParameters

CreateEventSubscription

RemoveTagsFromResource

CreateDBInstance

RestoreDBInstanceFromDBSnapshot

AuthorizeDBSecurityGroupIngress

DeleteDBClusterParameterGroup

PurchaseReservedDBInstancesOffering

DescribeCertificates

RestoreDBClusterFromSnapshot

CreateDBSnapshot

DeleteEventSubscription

DescribeDBParameterGroups (Paginated)

DescribeOrderableDBInstanceOptions (Paginated)

CreateDBClusterParameterGroup

DescribeEventSubscriptions (Paginated)

AddTagsToResource

DescribeOptionGroupOptions (Paginated)

DescribeDBParameters (Paginated)

DeleteDBClusterSnapshot

DescribeDBSnapshots (Paginated)

DescribeDBSubnetGroups (Paginated)

CreateDBParameterGroup

CreateDBClusterSnapshot

ModifyOptionGroup

ModifyDBCluster

DescribeEventCategories

ModifyDBClusterParameterGroup

DescribePendingMaintenanceActions

RestoreDBInstanceToPointInTime

ResetDBParameterGroup

CopyDBClusterSnapshot

ModifyDBParameterGroup

FailoverDBCluster

CreateDBCluster

CreateOptionGroup

ApplyPendingMaintenanceAction

RevokeDBSecurityGroupIngress

DeleteDBSnapshot

DescribeDBClusterParameters

CreateDBSecurityGroup

DeleteDBSubnetGroup

DescribeAccountAttributes

DeleteDBSecurityGroup

RebootDBInstance

DescribeDBClusterSnapshots

CreateDBSubnetGroup

DescribeReservedDBInstancesOfferings (Paginated)

DeleteDBInstance

DescribeDBInstances (Paginated)

CopyOptionGroup

DownloadDBLogFilePortion (Paginated)

CreateDBInstanceReadReplica

RestoreDBClusterToPointInTime

DeleteDBParameterGroup

DescribeDBSecurityGroups (Paginated)

Types

ApplyMethod

SourceType

AccountQuota

data AccountQuota Source

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

See: accountQuota smart constructor.

accountQuota :: AccountQuota Source

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

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

aqMax :: Lens' AccountQuota (Maybe Integer) Source

The maximum allowed value for the quota.

aqUsed :: Lens' AccountQuota (Maybe Integer) Source

The amount currently used toward the quota maximum.

aqAccountQuotaName :: Lens' AccountQuota (Maybe Text) Source

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

AvailabilityZone

data AvailabilityZone Source

Contains Availability Zone information.

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

  • OrderableDBInstanceOption

See: availabilityZone smart constructor.

availabilityZone :: AvailabilityZone Source

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

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

azName :: Lens' AvailabilityZone (Maybe Text) Source

The name of the availability zone.

Certificate

data Certificate Source

A CA certificate for an AWS account.

See: certificate smart constructor.

certificate :: Certificate Source

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

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

cCertificateType :: Lens' Certificate (Maybe Text) Source

The type of the certificate.

cValidTill :: Lens' Certificate (Maybe UTCTime) Source

The final date that the certificate continues to be valid.

cCertificateIdentifier :: Lens' Certificate (Maybe Text) Source

The unique key that identifies a certificate.

cThumbprint :: Lens' Certificate (Maybe Text) Source

The thumbprint of the certificate.

cValidFrom :: Lens' Certificate (Maybe UTCTime) Source

The starting date from which the certificate is valid.

CharacterSet

data CharacterSet Source

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

See: characterSet smart constructor.

characterSet :: CharacterSet Source

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

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

csCharacterSetName :: Lens' CharacterSet (Maybe Text) Source

The name of the character set.

csCharacterSetDescription :: Lens' CharacterSet (Maybe Text) Source

The description of the character set.

DBCluster

data DBCluster Source

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

  • CreateDBCluster
  • DeleteDBCluster
  • FailoverDBCluster
  • ModifyDBCluster
  • RestoreDBClusterFromSnapshot

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

See: dbCluster smart constructor.

dcEngineVersion :: Lens' DBCluster (Maybe Text) Source

Indicates the database engine version.

dcStatus :: Lens' DBCluster (Maybe Text) Source

Specifies the current state of this DB cluster.

dcDBClusterIdentifier :: Lens' DBCluster (Maybe Text) Source

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

dcDBClusterMembers :: Lens' DBCluster [DBClusterMember] Source

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

dcDBClusterParameterGroup :: Lens' DBCluster (Maybe Text) Source

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

dcMasterUsername :: Lens' DBCluster (Maybe Text) Source

Contains the master username for the DB cluster.

dcEarliestRestorableTime :: Lens' DBCluster (Maybe UTCTime) Source

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

dcEngine :: Lens' DBCluster (Maybe Text) Source

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

dcLatestRestorableTime :: Lens' DBCluster (Maybe UTCTime) Source

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

dcPreferredMaintenanceWindow :: Lens' DBCluster (Maybe Text) Source

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

dcCharacterSetName :: Lens' DBCluster (Maybe Text) Source

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

dcAvailabilityZones :: Lens' DBCluster [Text] Source

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

dcPreferredBackupWindow :: Lens' DBCluster (Maybe Text) Source

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

dcVPCSecurityGroups :: Lens' DBCluster [VPCSecurityGroupMembership] Source

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

dcBackupRetentionPeriod :: Lens' DBCluster (Maybe Int) Source

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

dcDatabaseName :: Lens' DBCluster (Maybe Text) Source

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

dcDBSubnetGroup :: Lens' DBCluster (Maybe Text) Source

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

dcAllocatedStorage :: Lens' DBCluster (Maybe Int) Source

Specifies the allocated storage size in gigabytes (GB).

dcEndpoint :: Lens' DBCluster (Maybe Text) Source

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

dcPercentProgress :: Lens' DBCluster (Maybe Text) Source

Specifies the progress of the operation as a percentage.

dcPort :: Lens' DBCluster (Maybe Int) Source

Specifies the port that the database engine is listening on.

dcDBClusterOptionGroupMemberships :: Lens' DBCluster [DBClusterOptionGroupStatus] Source

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

DBClusterMember

data DBClusterMember Source

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

See: dbClusterMember smart constructor.

dbClusterMember :: DBClusterMember Source

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

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

dcmDBInstanceIdentifier :: Lens' DBClusterMember (Maybe Text) Source

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

dcmIsClusterWriter :: Lens' DBClusterMember (Maybe Bool) Source

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

dcmDBClusterParameterGroupStatus :: Lens' DBClusterMember (Maybe Text) Source

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

DBClusterOptionGroupStatus

dbClusterOptionGroupStatus :: DBClusterOptionGroupStatus Source

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

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

dcogsStatus :: Lens' DBClusterOptionGroupStatus (Maybe Text) Source

Specifies the status of the DB cluster option group.

dcogsDBClusterOptionGroupName :: Lens' DBClusterOptionGroupStatus (Maybe Text) Source

Specifies the name of the DB cluster option group.

DBClusterParameterGroup

data DBClusterParameterGroup Source

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

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

See: dbClusterParameterGroup smart constructor.

dbClusterParameterGroup :: DBClusterParameterGroup Source

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

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

dcpgDBParameterGroupFamily :: Lens' DBClusterParameterGroup (Maybe Text) Source

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

dcpgDBClusterParameterGroupName :: Lens' DBClusterParameterGroup (Maybe Text) Source

Provides the name of the DB cluster parameter group.

dcpgDescription :: Lens' DBClusterParameterGroup (Maybe Text) Source

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

DBClusterParameterGroupNameMessage

dbClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage Source

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

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

dcpgnmDBClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text) Source

The name of the DB cluster parameter group.

Constraints:

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

This value is stored as a lowercase string.

DBClusterSnapshot

data DBClusterSnapshot Source

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

  • CreateDBClusterSnapshot
  • DeleteDBClusterSnapshot

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

See: dbClusterSnapshot smart constructor.

dcsEngineVersion :: Lens' DBClusterSnapshot (Maybe Text) Source

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

dcsStatus :: Lens' DBClusterSnapshot (Maybe Text) Source

Specifies the status of this DB cluster snapshot.

dcsDBClusterIdentifier :: Lens' DBClusterSnapshot (Maybe Text) Source

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

dcsMasterUsername :: Lens' DBClusterSnapshot (Maybe Text) Source

Provides the master username for the DB cluster snapshot.

dcsVPCId :: Lens' DBClusterSnapshot (Maybe Text) Source

Provides the VPC ID associated with the DB cluster snapshot.

dcsDBClusterSnapshotIdentifier :: Lens' DBClusterSnapshot (Maybe Text) Source

Specifies the identifier for the DB cluster snapshot.

dcsEngine :: Lens' DBClusterSnapshot (Maybe Text) Source

Specifies the name of the database engine.

dcsLicenseModel :: Lens' DBClusterSnapshot (Maybe Text) Source

Provides the license model information for this DB cluster snapshot.

dcsSnapshotType :: Lens' DBClusterSnapshot (Maybe Text) Source

Provides the type of the DB cluster snapshot.

dcsAvailabilityZones :: Lens' DBClusterSnapshot [Text] Source

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

dcsSnapshotCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime) Source

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

dcsAllocatedStorage :: Lens' DBClusterSnapshot (Maybe Int) Source

Specifies the allocated storage size in gigabytes (GB).

dcsClusterCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime) Source

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

dcsPercentProgress :: Lens' DBClusterSnapshot (Maybe Int) Source

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

dcsPort :: Lens' DBClusterSnapshot (Maybe Int) Source

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

DBEngineVersion

data DBEngineVersion Source

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

See: dbEngineVersion smart constructor.

dbEngineVersion :: DBEngineVersion Source

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

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

devDBEngineVersionDescription :: Lens' DBEngineVersion (Maybe Text) Source

The description of the database engine version.

devEngineVersion :: Lens' DBEngineVersion (Maybe Text) Source

The version number of the database engine.

devDefaultCharacterSet :: Lens' DBEngineVersion (Maybe CharacterSet) Source

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

devSupportedCharacterSets :: Lens' DBEngineVersion [CharacterSet] Source

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

devEngine :: Lens' DBEngineVersion (Maybe Text) Source

The name of the database engine.

devDBParameterGroupFamily :: Lens' DBEngineVersion (Maybe Text) Source

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

devDBEngineDescription :: Lens' DBEngineVersion (Maybe Text) Source

The description of the database engine.

DBInstance

data DBInstance Source

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

  • CreateDBInstance
  • DeleteDBInstance
  • ModifyDBInstance

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

See: dbInstance smart constructor.

diDBSecurityGroups :: Lens' DBInstance [DBSecurityGroupMembership] Source

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

diEngineVersion :: Lens' DBInstance (Maybe Text) Source

Indicates the database engine version.

diStorageEncrypted :: Lens' DBInstance (Maybe Bool) Source

Specifies whether the DB instance is encrypted.

diDBClusterIdentifier :: Lens' DBInstance (Maybe Text) Source

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

diAutoMinorVersionUpgrade :: Lens' DBInstance (Maybe Bool) Source

Indicates that minor version patches are applied automatically.

diMasterUsername :: Lens' DBInstance (Maybe Text) Source

Contains the master username for the DB instance.

diPubliclyAccessible :: Lens' DBInstance (Maybe Bool) Source

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

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

  • Default VPC:true
  • VPC:false

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

diReadReplicaDBInstanceIdentifiers :: Lens' DBInstance [Text] Source

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

diIOPS :: Lens' DBInstance (Maybe Int) Source

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

diInstanceCreateTime :: Lens' DBInstance (Maybe UTCTime) Source

Provides the date and time the DB instance was created.

diReadReplicaSourceDBInstanceIdentifier :: Lens' DBInstance (Maybe Text) Source

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

diEngine :: Lens' DBInstance (Maybe Text) Source

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

diLatestRestorableTime :: Lens' DBInstance (Maybe UTCTime) Source

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

diDBInstanceClass :: Lens' DBInstance (Maybe Text) Source

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

diLicenseModel :: Lens' DBInstance (Maybe Text) Source

License model information for this DB instance.

diPreferredMaintenanceWindow :: Lens' DBInstance (Maybe Text) Source

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

diCharacterSetName :: Lens' DBInstance (Maybe Text) Source

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

diDBInstanceIdentifier :: Lens' DBInstance (Maybe Text) Source

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

diCACertificateIdentifier :: Lens' DBInstance (Maybe Text) Source

The identifier of the CA certificate for this DB instance.

diPreferredBackupWindow :: Lens' DBInstance (Maybe Text) Source

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

diAvailabilityZone :: Lens' DBInstance (Maybe Text) Source

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

diVPCSecurityGroups :: Lens' DBInstance [VPCSecurityGroupMembership] Source

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

diBackupRetentionPeriod :: Lens' DBInstance (Maybe Int) Source

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

diKMSKeyId :: Lens' DBInstance (Maybe Text) Source

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

diDBSubnetGroup :: Lens' DBInstance (Maybe DBSubnetGroup) Source

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

diMultiAZ :: Lens' DBInstance (Maybe Bool) Source

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

diSecondaryAvailabilityZone :: Lens' DBInstance (Maybe Text) Source

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

diOptionGroupMemberships :: Lens' DBInstance [OptionGroupMembership] Source

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

diDBiResourceId :: Lens' DBInstance (Maybe Text) Source

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

diAllocatedStorage :: Lens' DBInstance (Maybe Int) Source

Specifies the allocated storage size specified in gigabytes.

diEndpoint :: Lens' DBInstance (Maybe Endpoint) Source

Specifies the connection endpoint.

diDBParameterGroups :: Lens' DBInstance [DBParameterGroupStatus] Source

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

diTDECredentialARN :: Lens' DBInstance (Maybe Text) Source

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

diCopyTagsToSnapshot :: Lens' DBInstance (Maybe Bool) Source

This property is not currently implemented.

diDBInstanceStatus :: Lens' DBInstance (Maybe Text) Source

Specifies the current state of this database.

diDBInstancePort :: Lens' DBInstance (Maybe Int) Source

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

diPendingModifiedValues :: Lens' DBInstance (Maybe PendingModifiedValues) Source

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

diStatusInfos :: Lens' DBInstance [DBInstanceStatusInfo] Source

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

diDBName :: Lens' DBInstance (Maybe Text) Source

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

MySQL, SQL Server, PostgreSQL

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

Type: String

Oracle

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

diDomainMemberships :: Lens' DBInstance [DomainMembership] Source

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

diStorageType :: Lens' DBInstance (Maybe Text) Source

Specifies the storage type associated with DB instance.

DBInstanceStatusInfo

dbInstanceStatusInfo :: DBInstanceStatusInfo Source

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

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

disiStatus :: Lens' DBInstanceStatusInfo (Maybe Text) Source

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

disiNormal :: Lens' DBInstanceStatusInfo (Maybe Bool) Source

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

disiStatusType :: Lens' DBInstanceStatusInfo (Maybe Text) Source

This value is currently "read replication."

disiMessage :: Lens' DBInstanceStatusInfo (Maybe Text) Source

Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

DBParameterGroup

data DBParameterGroup Source

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

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

See: dbParameterGroup smart constructor.

dbParameterGroup :: DBParameterGroup Source

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

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

dpgDBParameterGroupFamily :: Lens' DBParameterGroup (Maybe Text) Source

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

dpgDBParameterGroupName :: Lens' DBParameterGroup (Maybe Text) Source

Provides the name of the DB parameter group.

dpgDescription :: Lens' DBParameterGroup (Maybe Text) Source

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

DBParameterGroupNameMessage

dbParameterGroupNameMessage :: DBParameterGroupNameMessage Source

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

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

dpgnmDBParameterGroupName :: Lens' DBParameterGroupNameMessage (Maybe Text) Source

Provides the name of the DB parameter group.

DBParameterGroupStatus

data DBParameterGroupStatus Source

The status of the DB parameter group.

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

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

See: dbParameterGroupStatus smart constructor.

dbParameterGroupStatus :: DBParameterGroupStatus Source

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

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

dpgsDBParameterGroupName :: Lens' DBParameterGroupStatus (Maybe Text) Source

The name of the DP parameter group.

DBSecurityGroup

data DBSecurityGroup Source

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

  • DescribeDBSecurityGroups
  • AuthorizeDBSecurityGroupIngress
  • CreateDBSecurityGroup
  • RevokeDBSecurityGroupIngress

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

See: dbSecurityGroup smart constructor.

dbSecurityGroup :: DBSecurityGroup Source

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

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

dsgVPCId :: Lens' DBSecurityGroup (Maybe Text) Source

Provides the VpcId of the DB security group.

dsgOwnerId :: Lens' DBSecurityGroup (Maybe Text) Source

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

dsgIPRanges :: Lens' DBSecurityGroup [IPRange] Source

Contains a list of IPRange elements.

dsgDBSecurityGroupName :: Lens' DBSecurityGroup (Maybe Text) Source

Specifies the name of the DB security group.

dsgEC2SecurityGroups :: Lens' DBSecurityGroup [EC2SecurityGroup] Source

Contains a list of EC2SecurityGroup elements.

dsgDBSecurityGroupDescription :: Lens' DBSecurityGroup (Maybe Text) Source

Provides the description of the DB security group.

DBSecurityGroupMembership

data DBSecurityGroupMembership Source

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

  • ModifyDBInstance
  • RebootDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceToPointInTime

See: dbSecurityGroupMembership smart constructor.

dbSecurityGroupMembership :: DBSecurityGroupMembership Source

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

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

dsgmStatus :: Lens' DBSecurityGroupMembership (Maybe Text) Source

The status of the DB security group.

DBSnapshot

data DBSnapshot Source

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

  • CreateDBSnapshot
  • DeleteDBSnapshot

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

See: dbSnapshot smart constructor.

dsEngineVersion :: Lens' DBSnapshot (Maybe Text) Source

Specifies the version of the database engine.

dsStatus :: Lens' DBSnapshot (Maybe Text) Source

Specifies the status of this DB snapshot.

dsMasterUsername :: Lens' DBSnapshot (Maybe Text) Source

Provides the master username for the DB snapshot.

dsSourceRegion :: Lens' DBSnapshot (Maybe Text) Source

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

dsIOPS :: Lens' DBSnapshot (Maybe Int) Source

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

dsInstanceCreateTime :: Lens' DBSnapshot (Maybe UTCTime) Source

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

dsVPCId :: Lens' DBSnapshot (Maybe Text) Source

Provides the VPC ID associated with the DB snapshot.

dsEngine :: Lens' DBSnapshot (Maybe Text) Source

Specifies the name of the database engine.

dsEncrypted :: Lens' DBSnapshot (Maybe Bool) Source

Specifies whether the DB snapshot is encrypted.

dsDBSnapshotIdentifier :: Lens' DBSnapshot (Maybe Text) Source

Specifies the identifier for the DB snapshot.

dsLicenseModel :: Lens' DBSnapshot (Maybe Text) Source

License model information for the restored DB instance.

dsSnapshotType :: Lens' DBSnapshot (Maybe Text) Source

Provides the type of the DB snapshot.

dsDBInstanceIdentifier :: Lens' DBSnapshot (Maybe Text) Source

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

dsSourceDBSnapshotIdentifier :: Lens' DBSnapshot (Maybe Text) Source

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

dsAvailabilityZone :: Lens' DBSnapshot (Maybe Text) Source

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

dsKMSKeyId :: Lens' DBSnapshot (Maybe Text) Source

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

dsSnapshotCreateTime :: Lens' DBSnapshot (Maybe UTCTime) Source

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

dsAllocatedStorage :: Lens' DBSnapshot (Maybe Int) Source

Specifies the allocated storage size in gigabytes (GB).

dsTDECredentialARN :: Lens' DBSnapshot (Maybe Text) Source

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

dsOptionGroupName :: Lens' DBSnapshot (Maybe Text) Source

Provides the option group name for the DB snapshot.

dsPercentProgress :: Lens' DBSnapshot (Maybe Int) Source

The percentage of the estimated data that has been transferred.

dsPort :: Lens' DBSnapshot (Maybe Int) Source

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

dsStorageType :: Lens' DBSnapshot (Maybe Text) Source

Specifies the storage type associated with DB Snapshot.

DBSubnetGroup

data DBSubnetGroup Source

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

  • CreateDBSubnetGroup
  • ModifyDBSubnetGroup
  • DescribeDBSubnetGroups
  • DeleteDBSubnetGroup

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

See: dbSubnetGroup smart constructor.

dbSubnetGroup :: DBSubnetGroup Source

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

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

dbsgDBSubnetGroupName :: Lens' DBSubnetGroup (Maybe Text) Source

Specifies the name of the DB subnet group.

dbsgVPCId :: Lens' DBSubnetGroup (Maybe Text) Source

Provides the VpcId of the DB subnet group.

dbsgSubnets :: Lens' DBSubnetGroup [Subnet] Source

Contains a list of Subnet elements.

dbsgDBSubnetGroupDescription :: Lens' DBSubnetGroup (Maybe Text) Source

Provides the description of the DB subnet group.

dbsgSubnetGroupStatus :: Lens' DBSubnetGroup (Maybe Text) Source

Provides the status of the DB subnet group.

DescribeDBLogFilesDetails

describeDBLogFilesDetails :: DescribeDBLogFilesDetails Source

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

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

ddlfdLastWritten :: Lens' DescribeDBLogFilesDetails (Maybe Integer) Source

A POSIX timestamp when the last log entry was written.

ddlfdSize :: Lens' DescribeDBLogFilesDetails (Maybe Integer) Source

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

ddlfdLogFileName :: Lens' DescribeDBLogFilesDetails (Maybe Text) Source

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

DomainMembership

data DomainMembership Source

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

See: domainMembership smart constructor.

domainMembership :: DomainMembership Source

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

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

dmStatus :: Lens' DomainMembership (Maybe Text) Source

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

dmDomain :: Lens' DomainMembership (Maybe Text) Source

The identifier of the Active Directory Domain.

dmConnectivity :: Lens' DomainMembership (Maybe Text) Source

The observed connectivity of the Active Directory Domain.

EC2SecurityGroup

data EC2SecurityGroup Source

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

  • AuthorizeDBSecurityGroupIngress
  • DescribeDBSecurityGroups
  • RevokeDBSecurityGroupIngress

See: ec2SecurityGroup smart constructor.

ec2SecurityGroup :: EC2SecurityGroup Source

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

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

esgStatus :: Lens' EC2SecurityGroup (Maybe Text) Source

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

esgEC2SecurityGroupOwnerId :: Lens' EC2SecurityGroup (Maybe Text) Source

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

esgEC2SecurityGroupName :: Lens' EC2SecurityGroup (Maybe Text) Source

Specifies the name of the EC2 security group.

esgEC2SecurityGroupId :: Lens' EC2SecurityGroup (Maybe Text) Source

Specifies the id of the EC2 security group.

Endpoint

data Endpoint Source

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

  • CreateDBInstance
  • DescribeDBInstances
  • DeleteDBInstance

See: endpoint smart constructor.

endpoint :: Endpoint Source

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

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

eAddress :: Lens' Endpoint (Maybe Text) Source

Specifies the DNS address of the DB instance.

ePort :: Lens' Endpoint (Maybe Int) Source

Specifies the port that the database engine is listening on.

EngineDefaults

data EngineDefaults Source

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

See: engineDefaults smart constructor.

engineDefaults :: EngineDefaults Source

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

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

edDBParameterGroupFamily :: Lens' EngineDefaults (Maybe Text) Source

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

edParameters :: Lens' EngineDefaults [Parameter] Source

Contains a list of engine default parameters.

edMarker :: Lens' EngineDefaults (Maybe Text) Source

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

Event

data Event Source

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

See: event smart constructor.

event :: Event Source

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

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

eSourceType :: Lens' Event (Maybe SourceType) Source

Specifies the source type for this event.

eSourceIdentifier :: Lens' Event (Maybe Text) Source

Provides the identifier for the source of the event.

eDate :: Lens' Event (Maybe UTCTime) Source

Specifies the date and time of the event.

eEventCategories :: Lens' Event [Text] Source

Specifies the category for the event.

eMessage :: Lens' Event (Maybe Text) Source

Provides the text of this event.

EventCategoriesMap

data EventCategoriesMap Source

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

See: eventCategoriesMap smart constructor.

eventCategoriesMap :: EventCategoriesMap Source

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

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

ecmSourceType :: Lens' EventCategoriesMap (Maybe Text) Source

The source type that the returned categories belong to

ecmEventCategories :: Lens' EventCategoriesMap [Text] Source

The event categories for the specified source type

EventSubscription

data EventSubscription Source

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

See: eventSubscription smart constructor.

eventSubscription :: EventSubscription Source

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

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

esCustomerAWSId :: Lens' EventSubscription (Maybe Text) Source

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

esStatus :: Lens' EventSubscription (Maybe Text) Source

The status of the RDS event notification subscription.

Constraints:

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

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

esCustSubscriptionId :: Lens' EventSubscription (Maybe Text) Source

The RDS event notification subscription Id.

esSNSTopicARN :: Lens' EventSubscription (Maybe Text) Source

The topic ARN of the RDS event notification subscription.

esEnabled :: Lens' EventSubscription (Maybe Bool) Source

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

esSourceType :: Lens' EventSubscription (Maybe Text) Source

The source type for the RDS event notification subscription.

esSubscriptionCreationTime :: Lens' EventSubscription (Maybe Text) Source

The time the RDS event notification subscription was created.

esEventCategoriesList :: Lens' EventSubscription [Text] Source

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

esSourceIdsList :: Lens' EventSubscription [Text] Source

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

Filter

filter' Source

Arguments

:: Text

fName

-> Filter 

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

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

fName :: Lens' Filter Text Source

This parameter is not currently supported.

fValues :: Lens' Filter [Text] Source

This parameter is not currently supported.

IPRange

data IPRange Source

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

See: ipRange smart constructor.

ipRange :: IPRange Source

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

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

irStatus :: Lens' IPRange (Maybe Text) Source

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

irCIdRIP :: Lens' IPRange (Maybe Text) Source

Specifies the IP range.

Option

data Option Source

Option details.

See: option smart constructor.

option :: Option Source

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

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

oOptionName :: Lens' Option (Maybe Text) Source

The name of the option.

oPermanent :: Lens' Option (Maybe Bool) Source

Indicate if this option is permanent.

oPersistent :: Lens' Option (Maybe Bool) Source

Indicate if this option is persistent.

oOptionDescription :: Lens' Option (Maybe Text) Source

The description of the option.

oOptionSettings :: Lens' Option [OptionSetting] Source

The option settings for this option.

oVPCSecurityGroupMemberships :: Lens' Option [VPCSecurityGroupMembership] Source

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

oDBSecurityGroupMemberships :: Lens' Option [DBSecurityGroupMembership] Source

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

oPort :: Lens' Option (Maybe Int) Source

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

OptionConfiguration

optionConfiguration Source

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

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

ocOptionSettings :: Lens' OptionConfiguration [OptionSetting] Source

The option settings to include in an option group.

ocVPCSecurityGroupMemberships :: Lens' OptionConfiguration [Text] Source

A list of VpcSecurityGroupMemebrship name strings used for this option.

ocDBSecurityGroupMemberships :: Lens' OptionConfiguration [Text] Source

A list of DBSecurityGroupMemebrship name strings used for this option.

ocPort :: Lens' OptionConfiguration (Maybe Int) Source

The optional port for the option.

ocOptionName :: Lens' OptionConfiguration Text Source

The configuration of options to include in a group.

OptionGroup

optionGroup :: OptionGroup Source

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

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

ogOptionGroupDescription :: Lens' OptionGroup (Maybe Text) Source

Provides a description of the option group.

ogVPCId :: Lens' OptionGroup (Maybe Text) Source

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

ogAllowsVPCAndNonVPCInstanceMemberships :: Lens' OptionGroup (Maybe Bool) Source

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

ogEngineName :: Lens' OptionGroup (Maybe Text) Source

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

ogMajorEngineVersion :: Lens' OptionGroup (Maybe Text) Source

Indicates the major engine version associated with this option group.

ogOptions :: Lens' OptionGroup [Option] Source

Indicates what options are available in the option group.

ogOptionGroupName :: Lens' OptionGroup (Maybe Text) Source

Specifies the name of the option group.

OptionGroupMembership

optionGroupMembership :: OptionGroupMembership Source

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

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

ogmStatus :: Lens' OptionGroupMembership (Maybe Text) Source

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

ogmOptionGroupName :: Lens' OptionGroupMembership (Maybe Text) Source

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

OptionGroupOption

ogoMinimumRequiredMinorEngineVersion :: Lens' OptionGroupOption (Maybe Text) Source

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

ogoPermanent :: Lens' OptionGroupOption (Maybe Bool) Source

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

ogoPersistent :: Lens' OptionGroupOption (Maybe Bool) Source

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

ogoEngineName :: Lens' OptionGroupOption (Maybe Text) Source

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

ogoName :: Lens' OptionGroupOption (Maybe Text) Source

The name of the option.

ogoMajorEngineVersion :: Lens' OptionGroupOption (Maybe Text) Source

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

ogoDefaultPort :: Lens' OptionGroupOption (Maybe Int) Source

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

ogoOptionGroupOptionSettings :: Lens' OptionGroupOption [OptionGroupOptionSetting] Source

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

ogoPortRequired :: Lens' OptionGroupOption (Maybe Bool) Source

Specifies whether the option requires a port.

ogoOptionsDependedOn :: Lens' OptionGroupOption [Text] Source

List of all options that are prerequisites for this option.

ogoDescription :: Lens' OptionGroupOption (Maybe Text) Source

The description of the option.

OptionGroupOptionSetting

data OptionGroupOptionSetting Source

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

See: optionGroupOptionSetting smart constructor.

optionGroupOptionSetting :: OptionGroupOptionSetting Source

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

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

ogosApplyType :: Lens' OptionGroupOptionSetting (Maybe Text) Source

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

ogosSettingName :: Lens' OptionGroupOptionSetting (Maybe Text) Source

The name of the option group option.

ogosDefaultValue :: Lens' OptionGroupOptionSetting (Maybe Text) Source

The default value for the option group option.

ogosIsModifiable :: Lens' OptionGroupOptionSetting (Maybe Bool) Source

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

ogosAllowedValues :: Lens' OptionGroupOptionSetting (Maybe Text) Source

Indicates the acceptable values for the option group option.

ogosSettingDescription :: Lens' OptionGroupOptionSetting (Maybe Text) Source

The description of the option group option.

OptionSetting

data OptionSetting Source

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

See: optionSetting smart constructor.

optionSetting :: OptionSetting Source

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

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

osIsCollection :: Lens' OptionSetting (Maybe Bool) Source

Indicates if the option setting is part of a collection.

osApplyType :: Lens' OptionSetting (Maybe Text) Source

The DB engine specific parameter type.

osValue :: Lens' OptionSetting (Maybe Text) Source

The current value of the option setting.

osName :: Lens' OptionSetting (Maybe Text) Source

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

osDefaultValue :: Lens' OptionSetting (Maybe Text) Source

The default value of the option setting.

osIsModifiable :: Lens' OptionSetting (Maybe Bool) Source

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

osAllowedValues :: Lens' OptionSetting (Maybe Text) Source

The allowed values of the option setting.

osDataType :: Lens' OptionSetting (Maybe Text) Source

The data type of the option setting.

osDescription :: Lens' OptionSetting (Maybe Text) Source

The description of the option setting.

OrderableDBInstanceOption

data OrderableDBInstanceOption Source

Contains a list of available options for a DB instance

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

See: orderableDBInstanceOption smart constructor.

odioEngineVersion :: Lens' OrderableDBInstanceOption (Maybe Text) Source

The engine version of the orderable DB instance.

odioMultiAZCapable :: Lens' OrderableDBInstanceOption (Maybe Bool) Source

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

odioEngine :: Lens' OrderableDBInstanceOption (Maybe Text) Source

The engine type of the orderable DB instance.

odioSupportsIOPS :: Lens' OrderableDBInstanceOption (Maybe Bool) Source

Indicates whether this orderable DB instance supports provisioned IOPS.

odioDBInstanceClass :: Lens' OrderableDBInstanceOption (Maybe Text) Source

The DB instance class for the orderable DB instance.

odioLicenseModel :: Lens' OrderableDBInstanceOption (Maybe Text) Source

The license model for the orderable DB instance.

odioAvailabilityZones :: Lens' OrderableDBInstanceOption [AvailabilityZone] Source

A list of Availability Zones for the orderable DB instance.

odioReadReplicaCapable :: Lens' OrderableDBInstanceOption (Maybe Bool) Source

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

odioSupportsStorageEncryption :: Lens' OrderableDBInstanceOption (Maybe Bool) Source

Indicates whether this orderable DB instance supports encrypted storage.

odioVPC :: Lens' OrderableDBInstanceOption (Maybe Bool) Source

Indicates whether this is a VPC orderable DB instance.

odioStorageType :: Lens' OrderableDBInstanceOption (Maybe Text) Source

Indicates the storage type for this orderable DB instance.

Parameter

data Parameter Source

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

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

See: parameter smart constructor.

parameter :: Parameter Source

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

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

pApplyType :: Lens' Parameter (Maybe Text) Source

Specifies the engine specific parameters type.

pParameterValue :: Lens' Parameter (Maybe Text) Source

Specifies the value of the parameter.

pApplyMethod :: Lens' Parameter (Maybe ApplyMethod) Source

Indicates when to apply parameter updates.

pMinimumEngineVersion :: Lens' Parameter (Maybe Text) Source

The earliest engine version to which the parameter can apply.

pSource :: Lens' Parameter (Maybe Text) Source

Indicates the source of the parameter value.

pIsModifiable :: Lens' Parameter (Maybe Bool) Source

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

pAllowedValues :: Lens' Parameter (Maybe Text) Source

Specifies the valid range of values for the parameter.

pDataType :: Lens' Parameter (Maybe Text) Source

Specifies the valid data type for the parameter.

pParameterName :: Lens' Parameter (Maybe Text) Source

Specifies the name of the parameter.

pDescription :: Lens' Parameter (Maybe Text) Source

Provides a description of the parameter.

PendingMaintenanceAction

pendingMaintenanceAction :: PendingMaintenanceAction Source

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

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

pmaAutoAppliedAfterDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source

The date of the maintenance window when the action will be applied. The maintenance action will be applied to the resource during its first maintenance window after this date. If this date is specified, any 'next-maintenance' opt-in requests are ignored.

pmaAction :: Lens' PendingMaintenanceAction (Maybe Text) Source

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

pmaOptInStatus :: Lens' PendingMaintenanceAction (Maybe Text) Source

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

pmaDescription :: Lens' PendingMaintenanceAction (Maybe Text) Source

A description providing more detail about the maintenance action.

pmaCurrentApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source

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

pmaForcedApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source

The date when the maintenance action will be automatically applied. The maintenance action will be applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

PendingModifiedValues

pmvEngineVersion :: Lens' PendingModifiedValues (Maybe Text) Source

Indicates the database engine version.

pmvMasterUserPassword :: Lens' PendingModifiedValues (Maybe Text) Source

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

pmvIOPS :: Lens' PendingModifiedValues (Maybe Int) Source

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

pmvDBInstanceClass :: Lens' PendingModifiedValues (Maybe Text) Source

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

pmvDBInstanceIdentifier :: Lens' PendingModifiedValues (Maybe Text) Source

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

pmvCACertificateIdentifier :: Lens' PendingModifiedValues (Maybe Text) Source

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

pmvBackupRetentionPeriod :: Lens' PendingModifiedValues (Maybe Int) Source

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

pmvMultiAZ :: Lens' PendingModifiedValues (Maybe Bool) Source

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

pmvAllocatedStorage :: Lens' PendingModifiedValues (Maybe Int) Source

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

pmvPort :: Lens' PendingModifiedValues (Maybe Int) Source

Specifies the pending port for the DB instance.

pmvStorageType :: Lens' PendingModifiedValues (Maybe Text) Source

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

RecurringCharge

data RecurringCharge Source

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

See: recurringCharge smart constructor.

recurringCharge :: RecurringCharge Source

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

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

rcRecurringChargeFrequency :: Lens' RecurringCharge (Maybe Text) Source

The frequency of the recurring charge.

rcRecurringChargeAmount :: Lens' RecurringCharge (Maybe Double) Source

The amount of the recurring charge.

ReservedDBInstance

data ReservedDBInstance Source

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

See: reservedDBInstance smart constructor.

rdiDBInstanceCount :: Lens' ReservedDBInstance (Maybe Int) Source

The number of reserved DB instances.

rdiState :: Lens' ReservedDBInstance (Maybe Text) Source

The state of the reserved DB instance.

rdiCurrencyCode :: Lens' ReservedDBInstance (Maybe Text) Source

The currency code for the reserved DB instance.

rdiProductDescription :: Lens' ReservedDBInstance (Maybe Text) Source

The description of the reserved DB instance.

rdiStartTime :: Lens' ReservedDBInstance (Maybe UTCTime) Source

The time the reservation started.

rdiReservedDBInstanceId :: Lens' ReservedDBInstance (Maybe Text) Source

The unique identifier for the reservation.

rdiDBInstanceClass :: Lens' ReservedDBInstance (Maybe Text) Source

The DB instance class for the reserved DB instance.

rdiMultiAZ :: Lens' ReservedDBInstance (Maybe Bool) Source

Indicates if the reservation applies to Multi-AZ deployments.

rdiOfferingType :: Lens' ReservedDBInstance (Maybe Text) Source

The offering type of this reserved DB instance.

rdiUsagePrice :: Lens' ReservedDBInstance (Maybe Double) Source

The hourly price charged for this reserved DB instance.

rdiRecurringCharges :: Lens' ReservedDBInstance [RecurringCharge] Source

The recurring price charged to run this reserved DB instance.

rdiFixedPrice :: Lens' ReservedDBInstance (Maybe Double) Source

The fixed price charged for this reserved DB instance.

rdiDuration :: Lens' ReservedDBInstance (Maybe Int) Source

The duration of the reservation in seconds.

ReservedDBInstancesOffering

rdioCurrencyCode :: Lens' ReservedDBInstancesOffering (Maybe Text) Source

The currency code for the reserved DB instance offering.

rdioProductDescription :: Lens' ReservedDBInstancesOffering (Maybe Text) Source

The database engine used by the offering.

rdioDBInstanceClass :: Lens' ReservedDBInstancesOffering (Maybe Text) Source

The DB instance class for the reserved DB instance.

rdioMultiAZ :: Lens' ReservedDBInstancesOffering (Maybe Bool) Source

Indicates if the offering applies to Multi-AZ deployments.

rdioUsagePrice :: Lens' ReservedDBInstancesOffering (Maybe Double) Source

The hourly price charged for this offering.

rdioRecurringCharges :: Lens' ReservedDBInstancesOffering [RecurringCharge] Source

The recurring price charged to run this reserved DB instance.

rdioFixedPrice :: Lens' ReservedDBInstancesOffering (Maybe Double) Source

The fixed price charged for this offering.

rdioDuration :: Lens' ReservedDBInstancesOffering (Maybe Int) Source

The duration of the offering in seconds.

ResourcePendingMaintenanceActions

resourcePendingMaintenanceActions :: ResourcePendingMaintenanceActions Source

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

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

rpmaPendingMaintenanceActionDetails :: Lens' ResourcePendingMaintenanceActions [PendingMaintenanceAction] Source

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

rpmaResourceIdentifier :: Lens' ResourcePendingMaintenanceActions (Maybe Text) Source

The ARN of the resource that has pending maintenance actions.

Subnet

data Subnet Source

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

See: subnet smart constructor.

subnet :: Subnet Source

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

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

sSubnetStatus :: Lens' Subnet (Maybe Text) Source

Specifies the status of the subnet.

sSubnetIdentifier :: Lens' Subnet (Maybe Text) Source

Specifies the identifier of the subnet.

Tag

data Tag Source

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

See: tag smart constructor.

tag :: Tag Source

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

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

tagValue :: Lens' Tag (Maybe Text) Source

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

tagKey :: Lens' Tag (Maybe Text) Source

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

VPCSecurityGroupMembership

vpcSecurityGroupMembership :: VPCSecurityGroupMembership Source

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

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

vsgmStatus :: Lens' VPCSecurityGroupMembership (Maybe Text) Source

The status of the VPC security group.