amazonka-rds-2.0: Amazon Relational Database Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RDS.Types

Contents

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

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

Errors

_AuthorizationAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.

_AuthorizationNotFoundFault :: AsError a => Fold a ServiceError Source #

The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

_AuthorizationQuotaExceededFault :: AsError a => Fold a ServiceError Source #

The DB security group authorization quota has been reached.

_BackupPolicyNotFoundFault :: AsError a => Fold a ServiceError Source #

Prism for BackupPolicyNotFoundFault' errors.

_BlueGreenDeploymentAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

A blue/green deployment with the specified name already exists.

_BlueGreenDeploymentNotFoundFault :: AsError a => Fold a ServiceError Source #

BlueGreenDeploymentIdentifier doesn't refer to an existing blue/green deployment.

_CertificateNotFoundFault :: AsError a => Fold a ServiceError Source #

CertificateIdentifier doesn't refer to an existing certificate.

_CustomAvailabilityZoneNotFoundFault :: AsError a => Fold a ServiceError Source #

CustomAvailabilityZoneId doesn't refer to an existing custom Availability Zone identifier.

_CustomDBEngineVersionAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

A CEV with the specified name already exists.

_CustomDBEngineVersionNotFoundFault :: AsError a => Fold a ServiceError Source #

The specified CEV was not found.

_CustomDBEngineVersionQuotaExceededFault :: AsError a => Fold a ServiceError Source #

You have exceeded your CEV quota.

_DBClusterAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

The user already has a DB cluster with the given identifier.

_DBClusterBacktrackNotFoundFault :: AsError a => Fold a ServiceError Source #

BacktrackIdentifier doesn't refer to an existing backtrack.

_DBClusterEndpointAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

The specified custom endpoint can't be created because it already exists.

_DBClusterEndpointNotFoundFault :: AsError a => Fold a ServiceError Source #

The specified custom endpoint doesn't exist.

_DBClusterEndpointQuotaExceededFault :: AsError a => Fold a ServiceError Source #

The cluster already has the maximum number of custom endpoints.

_DBClusterNotFoundFault :: AsError a => Fold a ServiceError Source #

DBClusterIdentifier doesn't refer to an existing DB cluster.

_DBClusterParameterGroupNotFoundFault :: AsError a => Fold a ServiceError Source #

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

_DBClusterQuotaExceededFault :: AsError a => Fold a ServiceError Source #

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

_DBClusterRoleAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

_DBClusterRoleNotFoundFault :: AsError a => Fold a ServiceError Source #

The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.

_DBClusterRoleQuotaExceededFault :: AsError a => Fold a ServiceError Source #

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

_DBClusterSnapshotAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

The user already has a DB cluster snapshot with the given identifier.

_DBClusterSnapshotNotFoundFault :: AsError a => Fold a ServiceError Source #

DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

_DBInstanceAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

The user already has a DB instance with the given identifier.

_DBInstanceAutomatedBackupNotFoundFault :: AsError a => Fold a ServiceError Source #

No automated backup for this DB instance was found.

_DBInstanceAutomatedBackupQuotaExceededFault :: AsError a => Fold a ServiceError Source #

The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB Instance quota.

_DBInstanceNotFoundFault :: AsError a => Fold a ServiceError Source #

DBInstanceIdentifier doesn't refer to an existing DB instance.

_DBInstanceRoleAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

The specified RoleArn or FeatureName value is already associated with the DB instance.

_DBInstanceRoleNotFoundFault :: AsError a => Fold a ServiceError Source #

The specified RoleArn value doesn't match the specified feature for the DB instance.

_DBInstanceRoleQuotaExceededFault :: AsError a => Fold a ServiceError Source #

You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

_DBLogFileNotFoundFault :: AsError a => Fold a ServiceError Source #

LogFileName doesn't refer to an existing DB log file.

_DBParameterGroupAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

A DB parameter group with the same name exists.

_DBParameterGroupNotFoundFault :: AsError a => Fold a ServiceError Source #

DBParameterGroupName doesn't refer to an existing DB parameter group.

_DBParameterGroupQuotaExceededFault :: AsError a => Fold a ServiceError Source #

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

_DBProxyAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

_DBProxyEndpointAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.

_DBProxyEndpointNotFoundFault :: AsError a => Fold a ServiceError Source #

The DB proxy endpoint doesn't exist.

_DBProxyEndpointQuotaExceededFault :: AsError a => Fold a ServiceError Source #

The DB proxy already has the maximum number of endpoints.

_DBProxyNotFoundFault :: AsError a => Fold a ServiceError Source #

The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

_DBProxyQuotaExceededFault :: AsError a => Fold a ServiceError Source #

Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.

_DBProxyTargetAlreadyRegisteredFault :: AsError a => Fold a ServiceError Source #

The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.

_DBProxyTargetGroupNotFoundFault :: AsError a => Fold a ServiceError Source #

The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

_DBProxyTargetNotFoundFault :: AsError a => Fold a ServiceError Source #

The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

_DBSecurityGroupAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

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

_DBSecurityGroupNotFoundFault :: AsError a => Fold a ServiceError Source #

DBSecurityGroupName doesn't refer to an existing DB security group.

_DBSecurityGroupNotSupportedFault :: AsError a => Fold a ServiceError Source #

A DB security group isn't allowed for this action.

_DBSecurityGroupQuotaExceededFault :: AsError a => Fold a ServiceError Source #

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

_DBSnapshotAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

DBSnapshotIdentifier is already used by an existing snapshot.

_DBSnapshotNotFoundFault :: AsError a => Fold a ServiceError Source #

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

_DBSubnetGroupAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

DBSubnetGroupName is already used by an existing DB subnet group.

_DBSubnetGroupDoesNotCoverEnoughAZs :: AsError a => Fold a ServiceError Source #

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

_DBSubnetGroupNotAllowedFault :: AsError a => Fold a ServiceError Source #

The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.

_DBSubnetGroupNotFoundFault :: AsError a => Fold a ServiceError Source #

DBSubnetGroupName doesn't refer to an existing DB subnet group.

_DBSubnetGroupQuotaExceededFault :: AsError a => Fold a ServiceError Source #

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

_DBSubnetQuotaExceededFault :: AsError a => Fold a ServiceError Source #

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

_DBUpgradeDependencyFailureFault :: AsError a => Fold a ServiceError Source #

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

_DomainNotFoundFault :: AsError a => Fold a ServiceError Source #

Domain doesn't refer to an existing Active Directory domain.

_Ec2ImagePropertiesNotSupportedFault :: AsError a => Fold a ServiceError Source #

The AMI configuration prerequisite has not been met.

_EventSubscriptionQuotaExceededFault :: AsError a => Fold a ServiceError Source #

You have reached the maximum number of event subscriptions.

_ExportTaskAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

You can't start an export task that's already running.

_ExportTaskNotFoundFault :: AsError a => Fold a ServiceError Source #

The export task doesn't exist.

_GlobalClusterAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

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

_GlobalClusterNotFoundFault :: AsError a => Fold a ServiceError Source #

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

_GlobalClusterQuotaExceededFault :: AsError a => Fold a ServiceError Source #

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

_IamRoleMissingPermissionsFault :: AsError a => Fold a ServiceError Source #

The IAM role requires additional permissions to export to an Amazon S3 bucket.

_IamRoleNotFoundFault :: AsError a => Fold a ServiceError Source #

The IAM role is missing for exporting to an Amazon S3 bucket.

_InstanceQuotaExceededFault :: AsError a => Fold a ServiceError Source #

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

_InsufficientAvailableIPsInSubnetFault :: AsError a => Fold a ServiceError Source #

The requested operation can't be performed because there aren't enough available IP addresses in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the subnets.

_InsufficientDBClusterCapacityFault :: AsError a => Fold a ServiceError Source #

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

_InsufficientDBInstanceCapacityFault :: AsError a => Fold a ServiceError Source #

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

_InsufficientStorageClusterCapacityFault :: AsError a => Fold a ServiceError Source #

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

_InvalidBlueGreenDeploymentStateFault :: AsError a => Fold a ServiceError Source #

The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.

_InvalidDBClusterCapacityFault :: AsError a => Fold a ServiceError Source #

Capacity isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

_InvalidDBClusterEndpointStateFault :: AsError a => Fold a ServiceError Source #

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

_InvalidDBClusterSnapshotStateFault :: AsError a => Fold a ServiceError Source #

The supplied value isn't a valid DB cluster snapshot state.

_InvalidDBClusterStateFault :: AsError a => Fold a ServiceError Source #

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

_InvalidDBInstanceAutomatedBackupStateFault :: AsError a => Fold a ServiceError Source #

The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.

_InvalidDBInstanceStateFault :: AsError a => Fold a ServiceError Source #

The DB instance isn't in a valid state.

_InvalidDBParameterGroupStateFault :: AsError a => Fold a ServiceError Source #

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.

_InvalidDBProxyEndpointStateFault :: AsError a => Fold a ServiceError Source #

You can't perform this operation while the DB proxy endpoint is in a particular state.

_InvalidDBProxyStateFault :: AsError a => Fold a ServiceError Source #

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

_InvalidDBSecurityGroupStateFault :: AsError a => Fold a ServiceError Source #

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

_InvalidDBSnapshotStateFault :: AsError a => Fold a ServiceError Source #

The state of the DB snapshot doesn't allow deletion.

_InvalidDBSubnetGroupFault :: AsError a => Fold a ServiceError Source #

The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.

_InvalidDBSubnetGroupStateFault :: AsError a => Fold a ServiceError Source #

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

_InvalidDBSubnetStateFault :: AsError a => Fold a ServiceError Source #

The DB subnet isn't in the available state.

_InvalidEventSubscriptionStateFault :: AsError a => Fold a ServiceError Source #

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

_InvalidExportOnlyFault :: AsError a => Fold a ServiceError Source #

The export is invalid for exporting to an Amazon S3 bucket.

_InvalidExportSourceStateFault :: AsError a => Fold a ServiceError Source #

The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.

_InvalidExportTaskStateFault :: AsError a => Fold a ServiceError Source #

You can't cancel an export task that has completed.

_InvalidGlobalClusterStateFault :: AsError a => Fold a ServiceError Source #

The global cluster is in an invalid state and can't perform the requested operation.

_InvalidOptionGroupStateFault :: AsError a => Fold a ServiceError Source #

The option group isn't in the available state.

_InvalidRestoreFault :: AsError a => Fold a ServiceError Source #

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

_InvalidS3BucketFault :: AsError a => Fold a ServiceError Source #

The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

_InvalidSubnet :: AsError a => Fold a ServiceError Source #

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

_InvalidVPCNetworkStateFault :: AsError a => Fold a ServiceError Source #

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

_KMSKeyNotAccessibleFault :: AsError a => Fold a ServiceError Source #

An error occurred accessing an Amazon Web Services KMS key.

_NetworkTypeNotSupported :: AsError a => Fold a ServiceError Source #

The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

_OptionGroupAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

The option group you are trying to create already exists.

_OptionGroupNotFoundFault :: AsError a => Fold a ServiceError Source #

The specified option group could not be found.

_OptionGroupQuotaExceededFault :: AsError a => Fold a ServiceError Source #

The quota of 20 option groups was exceeded for this Amazon Web Services account.

_PointInTimeRestoreNotEnabledFault :: AsError a => Fold a ServiceError Source #

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

_ProvisionedIopsNotAvailableInAZFault :: AsError a => Fold a ServiceError Source #

Provisioned IOPS not available in the specified Availability Zone.

_ReservedDBInstanceAlreadyExistsFault :: AsError a => Fold a ServiceError Source #

User already has a reservation with the given identifier.

_ReservedDBInstanceNotFoundFault :: AsError a => Fold a ServiceError Source #

The specified reserved DB Instance not found.

_ReservedDBInstanceQuotaExceededFault :: AsError a => Fold a ServiceError Source #

Request would exceed the user's DB Instance quota.

_ReservedDBInstancesOfferingNotFoundFault :: AsError a => Fold a ServiceError Source #

Specified offering does not exist.

_ResourceNotFoundFault :: AsError a => Fold a ServiceError Source #

The specified resource ID was not found.

_SNSInvalidTopicFault :: AsError a => Fold a ServiceError Source #

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

_SNSNoAuthorizationFault :: AsError a => Fold a ServiceError Source #

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

_SNSTopicArnNotFoundFault :: AsError a => Fold a ServiceError Source #

The SNS topic ARN does not exist.

_SharedSnapshotQuotaExceededFault :: AsError a => Fold a ServiceError Source #

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

_SnapshotQuotaExceededFault :: AsError a => Fold a ServiceError Source #

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

_SourceClusterNotSupportedFault :: AsError a => Fold a ServiceError Source #

The source DB cluster isn't supported for a blue/green deployment.

_SourceDatabaseNotSupportedFault :: AsError a => Fold a ServiceError Source #

The source DB instance isn't supported for a blue/green deployment.

_SourceNotFoundFault :: AsError a => Fold a ServiceError Source #

The requested source could not be found.

_StorageQuotaExceededFault :: AsError a => Fold a ServiceError Source #

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

_StorageTypeNotSupportedFault :: AsError a => Fold a ServiceError Source #

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

_SubnetAlreadyInUse :: AsError a => Fold a ServiceError Source #

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

_SubscriptionAlreadyExistFault :: AsError a => Fold a ServiceError Source #

The supplied subscription name already exists.

_SubscriptionCategoryNotFoundFault :: AsError a => Fold a ServiceError Source #

The supplied category does not exist.

_SubscriptionNotFoundFault :: AsError a => Fold a ServiceError Source #

The subscription name does not exist.

ActivityStreamMode

newtype ActivityStreamMode Source #

Instances

Instances details
FromJSON ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

FromJSONKey ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

ToJSON ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

ToJSONKey ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

ToByteString ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

ToHeader ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

ToLog ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

ToQuery ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

FromText ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

ToText ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

FromXML ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

ToXML ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

Generic ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

Associated Types

type Rep ActivityStreamMode :: Type -> Type #

Read ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

Show ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

NFData ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

Methods

rnf :: ActivityStreamMode -> () #

Eq ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

Ord ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

Hashable ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

type Rep ActivityStreamMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamMode

type Rep ActivityStreamMode = D1 ('MetaData "ActivityStreamMode" "Amazonka.RDS.Types.ActivityStreamMode" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "ActivityStreamMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromActivityStreamMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ActivityStreamPolicyStatus

newtype ActivityStreamPolicyStatus Source #

Instances

Instances details
FromJSON ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

FromJSONKey ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

ToJSON ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

ToJSONKey ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

ToByteString ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

ToHeader ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

ToLog ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

ToQuery ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

FromText ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

ToText ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

FromXML ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

ToXML ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

Generic ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

Associated Types

type Rep ActivityStreamPolicyStatus :: Type -> Type #

Read ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

Show ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

NFData ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

Eq ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

Ord ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

Hashable ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

type Rep ActivityStreamPolicyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamPolicyStatus

type Rep ActivityStreamPolicyStatus = D1 ('MetaData "ActivityStreamPolicyStatus" "Amazonka.RDS.Types.ActivityStreamPolicyStatus" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "ActivityStreamPolicyStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromActivityStreamPolicyStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ActivityStreamStatus

newtype ActivityStreamStatus Source #

Instances

Instances details
FromJSON ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

FromJSONKey ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

ToJSON ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

ToJSONKey ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

ToByteString ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

ToHeader ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

ToLog ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

ToQuery ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

FromText ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

ToText ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

FromXML ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

ToXML ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

Generic ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

Associated Types

type Rep ActivityStreamStatus :: Type -> Type #

Read ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

Show ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

NFData ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

Methods

rnf :: ActivityStreamStatus -> () #

Eq ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

Ord ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

Hashable ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

type Rep ActivityStreamStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.ActivityStreamStatus

type Rep ActivityStreamStatus = D1 ('MetaData "ActivityStreamStatus" "Amazonka.RDS.Types.ActivityStreamStatus" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "ActivityStreamStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromActivityStreamStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ApplyMethod

newtype ApplyMethod Source #

Constructors

ApplyMethod' 

Instances

Instances details
FromJSON ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

FromJSONKey ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

ToJSON ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

ToJSONKey ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

ToByteString ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

ToHeader ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

ToLog ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

ToQuery ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

FromText ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

ToText ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

Methods

toText :: ApplyMethod -> Text #

FromXML ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

ToXML ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

Methods

toXML :: ApplyMethod -> XML #

Generic ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

Associated Types

type Rep ApplyMethod :: Type -> Type #

Read ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

Show ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

NFData ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

Methods

rnf :: ApplyMethod -> () #

Eq ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

Ord ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

Hashable ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

type Rep ApplyMethod Source # 
Instance details

Defined in Amazonka.RDS.Types.ApplyMethod

type Rep ApplyMethod = D1 ('MetaData "ApplyMethod" "Amazonka.RDS.Types.ApplyMethod" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "ApplyMethod'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromApplyMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AuditPolicyState

newtype AuditPolicyState Source #

Instances

Instances details
FromJSON AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

FromJSONKey AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

ToJSON AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

ToJSONKey AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

ToByteString AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

ToHeader AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

ToLog AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

ToQuery AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

FromText AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

ToText AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

FromXML AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

ToXML AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

Generic AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

Associated Types

type Rep AuditPolicyState :: Type -> Type #

Read AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

Show AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

NFData AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

Methods

rnf :: AuditPolicyState -> () #

Eq AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

Ord AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

Hashable AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

type Rep AuditPolicyState Source # 
Instance details

Defined in Amazonka.RDS.Types.AuditPolicyState

type Rep AuditPolicyState = D1 ('MetaData "AuditPolicyState" "Amazonka.RDS.Types.AuditPolicyState" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "AuditPolicyState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAuditPolicyState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AuthScheme

newtype AuthScheme Source #

Constructors

AuthScheme' 

Fields

Bundled Patterns

pattern AuthScheme_SECRETS :: AuthScheme 

Instances

Instances details
FromJSON AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

FromJSONKey AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

ToJSON AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

ToJSONKey AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

ToByteString AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

ToHeader AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

ToLog AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

ToQuery AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

FromText AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

ToText AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

Methods

toText :: AuthScheme -> Text #

FromXML AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

ToXML AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

Methods

toXML :: AuthScheme -> XML #

Generic AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

Associated Types

type Rep AuthScheme :: Type -> Type #

Read AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

Show AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

NFData AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

Methods

rnf :: AuthScheme -> () #

Eq AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

Ord AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

Hashable AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

type Rep AuthScheme Source # 
Instance details

Defined in Amazonka.RDS.Types.AuthScheme

type Rep AuthScheme = D1 ('MetaData "AuthScheme" "Amazonka.RDS.Types.AuthScheme" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "AuthScheme'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAuthScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AutomationMode

newtype AutomationMode Source #

Constructors

AutomationMode' 

Instances

Instances details
FromJSON AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

FromJSONKey AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

ToJSON AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

ToJSONKey AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

ToByteString AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

ToHeader AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

ToLog AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

ToQuery AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

FromText AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

ToText AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

FromXML AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

ToXML AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

Methods

toXML :: AutomationMode -> XML #

Generic AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

Associated Types

type Rep AutomationMode :: Type -> Type #

Read AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

Show AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

NFData AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

Methods

rnf :: AutomationMode -> () #

Eq AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

Ord AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

Hashable AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

type Rep AutomationMode Source # 
Instance details

Defined in Amazonka.RDS.Types.AutomationMode

type Rep AutomationMode = D1 ('MetaData "AutomationMode" "Amazonka.RDS.Types.AutomationMode" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "AutomationMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAutomationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ClientPasswordAuthType

newtype ClientPasswordAuthType Source #

Instances

Instances details
FromJSON ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

FromJSONKey ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

ToJSON ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

ToJSONKey ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

ToByteString ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

ToHeader ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

ToLog ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

ToQuery ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

FromText ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

ToText ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

FromXML ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

ToXML ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

Generic ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

Associated Types

type Rep ClientPasswordAuthType :: Type -> Type #

Read ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

Show ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

NFData ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

Methods

rnf :: ClientPasswordAuthType -> () #

Eq ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

Ord ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

Hashable ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

type Rep ClientPasswordAuthType Source # 
Instance details

Defined in Amazonka.RDS.Types.ClientPasswordAuthType

type Rep ClientPasswordAuthType = D1 ('MetaData "ClientPasswordAuthType" "Amazonka.RDS.Types.ClientPasswordAuthType" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "ClientPasswordAuthType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromClientPasswordAuthType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CustomEngineVersionStatus

newtype CustomEngineVersionStatus Source #

Instances

Instances details
FromJSON CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

FromJSONKey CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

ToJSON CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

ToJSONKey CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

ToByteString CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

ToHeader CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

ToLog CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

ToQuery CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

FromText CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

ToText CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

FromXML CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

ToXML CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

Generic CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

Associated Types

type Rep CustomEngineVersionStatus :: Type -> Type #

Read CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

Show CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

NFData CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

Eq CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

Ord CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

Hashable CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

type Rep CustomEngineVersionStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomEngineVersionStatus

type Rep CustomEngineVersionStatus = D1 ('MetaData "CustomEngineVersionStatus" "Amazonka.RDS.Types.CustomEngineVersionStatus" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "CustomEngineVersionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCustomEngineVersionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DBProxyEndpointStatus

newtype DBProxyEndpointStatus Source #

Instances

Instances details
FromJSON DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

FromJSONKey DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

ToJSON DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

ToJSONKey DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

ToByteString DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

ToHeader DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

ToLog DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

ToQuery DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

FromText DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

ToText DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

FromXML DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

ToXML DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

Generic DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

Associated Types

type Rep DBProxyEndpointStatus :: Type -> Type #

Read DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

Show DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

NFData DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

Methods

rnf :: DBProxyEndpointStatus -> () #

Eq DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

Ord DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

Hashable DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

type Rep DBProxyEndpointStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointStatus

type Rep DBProxyEndpointStatus = D1 ('MetaData "DBProxyEndpointStatus" "Amazonka.RDS.Types.DBProxyEndpointStatus" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "DBProxyEndpointStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDBProxyEndpointStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DBProxyEndpointTargetRole

newtype DBProxyEndpointTargetRole Source #

Instances

Instances details
FromJSON DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

FromJSONKey DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

ToJSON DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

ToJSONKey DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

ToByteString DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

ToHeader DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

ToLog DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

ToQuery DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

FromText DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

ToText DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

FromXML DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

ToXML DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

Generic DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

Associated Types

type Rep DBProxyEndpointTargetRole :: Type -> Type #

Read DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

Show DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

NFData DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

Eq DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

Ord DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

Hashable DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

type Rep DBProxyEndpointTargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpointTargetRole

type Rep DBProxyEndpointTargetRole = D1 ('MetaData "DBProxyEndpointTargetRole" "Amazonka.RDS.Types.DBProxyEndpointTargetRole" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "DBProxyEndpointTargetRole'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDBProxyEndpointTargetRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DBProxyStatus

newtype DBProxyStatus Source #

Constructors

DBProxyStatus' 

Instances

Instances details
FromJSON DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

FromJSONKey DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

ToJSON DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

ToJSONKey DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

ToByteString DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

ToHeader DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

ToLog DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

ToQuery DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

FromText DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

ToText DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

Methods

toText :: DBProxyStatus -> Text #

FromXML DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

ToXML DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

Methods

toXML :: DBProxyStatus -> XML #

Generic DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

Associated Types

type Rep DBProxyStatus :: Type -> Type #

Read DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

Show DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

NFData DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

Methods

rnf :: DBProxyStatus -> () #

Eq DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

Ord DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

Hashable DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

type Rep DBProxyStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyStatus

type Rep DBProxyStatus = D1 ('MetaData "DBProxyStatus" "Amazonka.RDS.Types.DBProxyStatus" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "DBProxyStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDBProxyStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EngineFamily

newtype EngineFamily Source #

Constructors

EngineFamily' 

Instances

Instances details
FromJSON EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

FromJSONKey EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

ToJSON EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

ToJSONKey EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

ToByteString EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

ToHeader EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

ToLog EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

ToQuery EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

FromText EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

ToText EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

Methods

toText :: EngineFamily -> Text #

FromXML EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

ToXML EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

Methods

toXML :: EngineFamily -> XML #

Generic EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

Associated Types

type Rep EngineFamily :: Type -> Type #

Read EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

Show EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

NFData EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

Methods

rnf :: EngineFamily -> () #

Eq EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

Ord EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

Hashable EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

type Rep EngineFamily Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineFamily

type Rep EngineFamily = D1 ('MetaData "EngineFamily" "Amazonka.RDS.Types.EngineFamily" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "EngineFamily'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEngineFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ExportSourceType

newtype ExportSourceType Source #

Instances

Instances details
FromJSON ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

FromJSONKey ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

ToJSON ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

ToJSONKey ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

ToByteString ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

ToHeader ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

ToLog ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

ToQuery ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

FromText ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

ToText ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

FromXML ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

ToXML ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

Generic ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

Associated Types

type Rep ExportSourceType :: Type -> Type #

Read ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

Show ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

NFData ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

Methods

rnf :: ExportSourceType -> () #

Eq ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

Ord ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

Hashable ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

type Rep ExportSourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportSourceType

type Rep ExportSourceType = D1 ('MetaData "ExportSourceType" "Amazonka.RDS.Types.ExportSourceType" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "ExportSourceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromExportSourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

FailoverStatus

newtype FailoverStatus Source #

Constructors

FailoverStatus' 

Instances

Instances details
FromJSON FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

FromJSONKey FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

ToJSON FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

ToJSONKey FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

ToByteString FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

ToHeader FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

ToLog FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

ToQuery FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

FromText FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

ToText FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

FromXML FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

ToXML FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

Methods

toXML :: FailoverStatus -> XML #

Generic FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

Associated Types

type Rep FailoverStatus :: Type -> Type #

Read FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

Show FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

NFData FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

Methods

rnf :: FailoverStatus -> () #

Eq FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

Ord FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

Hashable FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

type Rep FailoverStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverStatus

type Rep FailoverStatus = D1 ('MetaData "FailoverStatus" "Amazonka.RDS.Types.FailoverStatus" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "FailoverStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFailoverStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

IAMAuthMode

newtype IAMAuthMode Source #

Constructors

IAMAuthMode' 

Instances

Instances details
FromJSON IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

FromJSONKey IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

ToJSON IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

ToJSONKey IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

ToByteString IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

ToHeader IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

ToLog IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

ToQuery IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

FromText IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

ToText IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

Methods

toText :: IAMAuthMode -> Text #

FromXML IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

ToXML IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

Methods

toXML :: IAMAuthMode -> XML #

Generic IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

Associated Types

type Rep IAMAuthMode :: Type -> Type #

Read IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

Show IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

NFData IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

Methods

rnf :: IAMAuthMode -> () #

Eq IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

Ord IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

Hashable IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

type Rep IAMAuthMode Source # 
Instance details

Defined in Amazonka.RDS.Types.IAMAuthMode

type Rep IAMAuthMode = D1 ('MetaData "IAMAuthMode" "Amazonka.RDS.Types.IAMAuthMode" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "IAMAuthMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromIAMAuthMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ReplicaMode

newtype ReplicaMode Source #

Constructors

ReplicaMode' 

Instances

Instances details
FromJSON ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

FromJSONKey ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

ToJSON ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

ToJSONKey ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

ToByteString ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

ToHeader ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

ToLog ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

ToQuery ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

FromText ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

ToText ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

Methods

toText :: ReplicaMode -> Text #

FromXML ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

ToXML ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

Methods

toXML :: ReplicaMode -> XML #

Generic ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

Associated Types

type Rep ReplicaMode :: Type -> Type #

Read ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

Show ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

NFData ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

Methods

rnf :: ReplicaMode -> () #

Eq ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

Ord ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

Hashable ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

type Rep ReplicaMode Source # 
Instance details

Defined in Amazonka.RDS.Types.ReplicaMode

type Rep ReplicaMode = D1 ('MetaData "ReplicaMode" "Amazonka.RDS.Types.ReplicaMode" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "ReplicaMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromReplicaMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SourceType

newtype SourceType Source #

Constructors

SourceType' 

Fields

Instances

Instances details
FromJSON SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

FromJSONKey SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

ToJSON SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

ToJSONKey SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

ToByteString SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

ToHeader SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

ToLog SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

ToQuery SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

FromText SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

ToText SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

Methods

toText :: SourceType -> Text #

FromXML SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

ToXML SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

Methods

toXML :: SourceType -> XML #

Generic SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

Associated Types

type Rep SourceType :: Type -> Type #

Read SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

Show SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

NFData SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

Methods

rnf :: SourceType -> () #

Eq SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

Ord SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

Hashable SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

type Rep SourceType Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceType

type Rep SourceType = D1 ('MetaData "SourceType" "Amazonka.RDS.Types.SourceType" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "SourceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TargetHealthReason

newtype TargetHealthReason Source #

Instances

Instances details
FromJSON TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

FromJSONKey TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

ToJSON TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

ToJSONKey TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

ToByteString TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

ToHeader TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

ToLog TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

ToQuery TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

FromText TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

ToText TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

FromXML TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

ToXML TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

Generic TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

Associated Types

type Rep TargetHealthReason :: Type -> Type #

Read TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

Show TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

NFData TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

Methods

rnf :: TargetHealthReason -> () #

Eq TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

Ord TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

Hashable TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

type Rep TargetHealthReason Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealthReason

type Rep TargetHealthReason = D1 ('MetaData "TargetHealthReason" "Amazonka.RDS.Types.TargetHealthReason" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "TargetHealthReason'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTargetHealthReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TargetRole

newtype TargetRole Source #

Constructors

TargetRole' 

Fields

Instances

Instances details
FromJSON TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

FromJSONKey TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

ToJSON TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

ToJSONKey TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

ToByteString TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

ToHeader TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

ToLog TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

ToQuery TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

FromText TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

ToText TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

Methods

toText :: TargetRole -> Text #

FromXML TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

ToXML TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

Methods

toXML :: TargetRole -> XML #

Generic TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

Associated Types

type Rep TargetRole :: Type -> Type #

Read TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

Show TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

NFData TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

Methods

rnf :: TargetRole -> () #

Eq TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

Ord TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

Hashable TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

type Rep TargetRole Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetRole

type Rep TargetRole = D1 ('MetaData "TargetRole" "Amazonka.RDS.Types.TargetRole" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "TargetRole'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTargetRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TargetState

newtype TargetState Source #

Constructors

TargetState' 

Instances

Instances details
FromJSON TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

FromJSONKey TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

ToJSON TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

ToJSONKey TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

ToByteString TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

ToHeader TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

ToLog TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

ToQuery TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

FromText TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

ToText TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

Methods

toText :: TargetState -> Text #

FromXML TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

ToXML TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

Methods

toXML :: TargetState -> XML #

Generic TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

Associated Types

type Rep TargetState :: Type -> Type #

Read TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

Show TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

NFData TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

Methods

rnf :: TargetState -> () #

Eq TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

Ord TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

Hashable TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

type Rep TargetState Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetState

type Rep TargetState = D1 ('MetaData "TargetState" "Amazonka.RDS.Types.TargetState" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "TargetState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTargetState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TargetType

newtype TargetType Source #

Constructors

TargetType' 

Fields

Instances

Instances details
FromJSON TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

FromJSONKey TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

ToJSON TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

ToJSONKey TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

ToByteString TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

ToHeader TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

ToLog TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

ToQuery TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

FromText TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

ToText TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

Methods

toText :: TargetType -> Text #

FromXML TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

ToXML TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

Methods

toXML :: TargetType -> XML #

Generic TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

Associated Types

type Rep TargetType :: Type -> Type #

Read TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

Show TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

NFData TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

Methods

rnf :: TargetType -> () #

Eq TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

Ord TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

Hashable TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

type Rep TargetType Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetType

type Rep TargetType = D1 ('MetaData "TargetType" "Amazonka.RDS.Types.TargetType" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "TargetType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTargetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

WriteForwardingStatus

newtype WriteForwardingStatus Source #

Instances

Instances details
FromJSON WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

FromJSONKey WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

ToJSON WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

ToJSONKey WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

ToByteString WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

ToHeader WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

ToLog WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

ToQuery WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

FromText WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

ToText WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

FromXML WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

ToXML WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

Generic WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

Associated Types

type Rep WriteForwardingStatus :: Type -> Type #

Read WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

Show WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

NFData WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

Methods

rnf :: WriteForwardingStatus -> () #

Eq WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

Ord WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

Hashable WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

type Rep WriteForwardingStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.WriteForwardingStatus

type Rep WriteForwardingStatus = D1 ('MetaData "WriteForwardingStatus" "Amazonka.RDS.Types.WriteForwardingStatus" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'True) (C1 ('MetaCons "WriteForwardingStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromWriteForwardingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AccountQuota

data AccountQuota Source #

Describes a quota for an Amazon Web Services account.

The following are account quotas:

  • AllocatedStorage - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.
  • AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.
  • CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.
  • DBClusterParameterGroups - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.
  • DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.
  • DBClusters - The number of DB clusters per account. The used value is the count of DB clusters in the account.
  • DBInstanceRoles - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.
  • DBInstances - The number of DB instances per account. The used value is the count of the DB instances in the account.

    Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.

  • DBParameterGroups - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.
  • DBSecurityGroups - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.
  • DBSubnetGroups - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.
  • EventSubscriptions - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.
  • ManualClusterSnapshots - The number of manual DB cluster snapshots per account. The used value is the count of the manual DB cluster snapshots in the account.
  • ManualSnapshots - The number of manual DB instance snapshots per account. The used value is the count of the manual DB instance snapshots in the account.
  • OptionGroups - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.
  • ReadReplicasPerMaster - The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas.
  • ReservedDBInstances - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.
  • SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.

For more information, see Quotas for Amazon RDS in the Amazon RDS User Guide and Quotas for Amazon Aurora in the Amazon Aurora User Guide.

See: newAccountQuota smart constructor.

Constructors

AccountQuota' 

Fields

Instances

Instances details
FromXML AccountQuota Source # 
Instance details

Defined in Amazonka.RDS.Types.AccountQuota

Generic AccountQuota Source # 
Instance details

Defined in Amazonka.RDS.Types.AccountQuota

Associated Types

type Rep AccountQuota :: Type -> Type #

Read AccountQuota Source # 
Instance details

Defined in Amazonka.RDS.Types.AccountQuota

Show AccountQuota Source # 
Instance details

Defined in Amazonka.RDS.Types.AccountQuota

NFData AccountQuota Source # 
Instance details

Defined in Amazonka.RDS.Types.AccountQuota

Methods

rnf :: AccountQuota -> () #

Eq AccountQuota Source # 
Instance details

Defined in Amazonka.RDS.Types.AccountQuota

Hashable AccountQuota Source # 
Instance details

Defined in Amazonka.RDS.Types.AccountQuota

type Rep AccountQuota Source # 
Instance details

Defined in Amazonka.RDS.Types.AccountQuota

type Rep AccountQuota = D1 ('MetaData "AccountQuota" "Amazonka.RDS.Types.AccountQuota" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "AccountQuota'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountQuotaName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "max") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "used") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))

newAccountQuota :: AccountQuota Source #

Create a value of AccountQuota with all optional fields omitted.

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

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

$sel:accountQuotaName:AccountQuota', accountQuota_accountQuotaName - The name of the Amazon RDS quota for this Amazon Web Services account.

$sel:max:AccountQuota', accountQuota_max - The maximum allowed value for the quota.

$sel:used:AccountQuota', accountQuota_used - The amount currently used toward the quota maximum.

accountQuota_accountQuotaName :: Lens' AccountQuota (Maybe Text) Source #

The name of the Amazon RDS quota for this Amazon Web Services account.

accountQuota_max :: Lens' AccountQuota (Maybe Integer) Source #

The maximum allowed value for the quota.

accountQuota_used :: Lens' AccountQuota (Maybe Integer) Source #

The amount currently used toward the quota maximum.

AvailabilityZone

data AvailabilityZone Source #

Contains Availability Zone information.

This data type is used as an element in the OrderableDBInstanceOption data type.

See: newAvailabilityZone smart constructor.

Constructors

AvailabilityZone' 

Fields

Instances

Instances details
FromXML AvailabilityZone Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailabilityZone

Generic AvailabilityZone Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailabilityZone

Associated Types

type Rep AvailabilityZone :: Type -> Type #

Read AvailabilityZone Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailabilityZone

Show AvailabilityZone Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailabilityZone

NFData AvailabilityZone Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailabilityZone

Methods

rnf :: AvailabilityZone -> () #

Eq AvailabilityZone Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailabilityZone

Hashable AvailabilityZone Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailabilityZone

type Rep AvailabilityZone Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailabilityZone

type Rep AvailabilityZone = D1 ('MetaData "AvailabilityZone" "Amazonka.RDS.Types.AvailabilityZone" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "AvailabilityZone'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newAvailabilityZone :: AvailabilityZone Source #

Create a value of AvailabilityZone with all optional fields omitted.

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

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

$sel:name:AvailabilityZone', availabilityZone_name - The name of the Availability Zone.

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

The name of the Availability Zone.

AvailableProcessorFeature

data AvailableProcessorFeature Source #

Contains the available processor feature information for the DB instance class of a DB instance.

For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

See: newAvailableProcessorFeature smart constructor.

Constructors

AvailableProcessorFeature' 

Fields

  • allowedValues :: Maybe Text

    The allowed values for the processor feature of the DB instance class.

  • defaultValue :: Maybe Text

    The default value for the processor feature of the DB instance class.

  • name :: Maybe Text

    The name of the processor feature. Valid names are coreCount and threadsPerCore.

Instances

Instances details
FromXML AvailableProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailableProcessorFeature

Generic AvailableProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailableProcessorFeature

Associated Types

type Rep AvailableProcessorFeature :: Type -> Type #

Read AvailableProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailableProcessorFeature

Show AvailableProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailableProcessorFeature

NFData AvailableProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailableProcessorFeature

Eq AvailableProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailableProcessorFeature

Hashable AvailableProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailableProcessorFeature

type Rep AvailableProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.AvailableProcessorFeature

type Rep AvailableProcessorFeature = D1 ('MetaData "AvailableProcessorFeature" "Amazonka.RDS.Types.AvailableProcessorFeature" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "AvailableProcessorFeature'" 'PrefixI 'True) (S1 ('MetaSel ('Just "allowedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newAvailableProcessorFeature :: AvailableProcessorFeature Source #

Create a value of AvailableProcessorFeature with all optional fields omitted.

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

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

$sel:allowedValues:AvailableProcessorFeature', availableProcessorFeature_allowedValues - The allowed values for the processor feature of the DB instance class.

$sel:defaultValue:AvailableProcessorFeature', availableProcessorFeature_defaultValue - The default value for the processor feature of the DB instance class.

$sel:name:AvailableProcessorFeature', availableProcessorFeature_name - The name of the processor feature. Valid names are coreCount and threadsPerCore.

availableProcessorFeature_allowedValues :: Lens' AvailableProcessorFeature (Maybe Text) Source #

The allowed values for the processor feature of the DB instance class.

availableProcessorFeature_defaultValue :: Lens' AvailableProcessorFeature (Maybe Text) Source #

The default value for the processor feature of the DB instance class.

availableProcessorFeature_name :: Lens' AvailableProcessorFeature (Maybe Text) Source #

The name of the processor feature. Valid names are coreCount and threadsPerCore.

BlueGreenDeployment

data BlueGreenDeployment Source #

Contains the details about a blue/green deployment.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

See: newBlueGreenDeployment smart constructor.

Constructors

BlueGreenDeployment' 

Fields

  • blueGreenDeploymentIdentifier :: Maybe Text

    The system-generated identifier of the blue/green deployment.

  • blueGreenDeploymentName :: Maybe Text

    The user-supplied name of the blue/green deployment.

  • createTime :: Maybe ISO8601

    Specifies the time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

  • deleteTime :: Maybe ISO8601

    Specifies the time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).

  • source :: Maybe Text

    The source database for the blue/green deployment.

    Before switchover, the source database is the production database in the blue environment.

  • status :: Maybe Text

    The status of the blue/green deployment.

    Values:

    • PROVISIONING - Resources are being created in the green environment.
    • AVAILABLE - Resources are available in the green environment.
    • SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the green environment.
    • SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.
    • INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.
    • SWITCHOVER_FAILED - Switchover was attempted but failed.
    • DELETING - The blue/green deployment is being deleted.
  • statusDetails :: Maybe Text

    Additional information about the status of the blue/green deployment.

  • switchoverDetails :: Maybe [SwitchoverDetail]

    The details about each source and target resource in the blue/green deployment.

  • tagList :: Maybe [Tag]
     
  • target :: Maybe Text

    The target database for the blue/green deployment.

    Before switchover, the target database is the clone database in the green environment.

  • tasks :: Maybe [BlueGreenDeploymentTask]

    Either tasks to be performed or tasks that have been completed on the target database before switchover.

Instances

Instances details
FromXML BlueGreenDeployment Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeployment

Generic BlueGreenDeployment Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeployment

Associated Types

type Rep BlueGreenDeployment :: Type -> Type #

Read BlueGreenDeployment Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeployment

Show BlueGreenDeployment Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeployment

NFData BlueGreenDeployment Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeployment

Methods

rnf :: BlueGreenDeployment -> () #

Eq BlueGreenDeployment Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeployment

Hashable BlueGreenDeployment Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeployment

type Rep BlueGreenDeployment Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeployment

type Rep BlueGreenDeployment = D1 ('MetaData "BlueGreenDeployment" "Amazonka.RDS.Types.BlueGreenDeployment" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "BlueGreenDeployment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "blueGreenDeploymentIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "blueGreenDeploymentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "deleteTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "statusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "switchoverDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SwitchoverDetail])))) :*: (S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BlueGreenDeploymentTask])))))))

newBlueGreenDeployment :: BlueGreenDeployment Source #

Create a value of BlueGreenDeployment with all optional fields omitted.

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

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

$sel:blueGreenDeploymentIdentifier:BlueGreenDeployment', blueGreenDeployment_blueGreenDeploymentIdentifier - The system-generated identifier of the blue/green deployment.

$sel:blueGreenDeploymentName:BlueGreenDeployment', blueGreenDeployment_blueGreenDeploymentName - The user-supplied name of the blue/green deployment.

$sel:createTime:BlueGreenDeployment', blueGreenDeployment_createTime - Specifies the time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

$sel:deleteTime:BlueGreenDeployment', blueGreenDeployment_deleteTime - Specifies the time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).

$sel:source:BlueGreenDeployment', blueGreenDeployment_source - The source database for the blue/green deployment.

Before switchover, the source database is the production database in the blue environment.

BlueGreenDeployment, blueGreenDeployment_status - The status of the blue/green deployment.

Values:

  • PROVISIONING - Resources are being created in the green environment.
  • AVAILABLE - Resources are available in the green environment.
  • SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the green environment.
  • SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.
  • INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.
  • SWITCHOVER_FAILED - Switchover was attempted but failed.
  • DELETING - The blue/green deployment is being deleted.

$sel:statusDetails:BlueGreenDeployment', blueGreenDeployment_statusDetails - Additional information about the status of the blue/green deployment.

$sel:switchoverDetails:BlueGreenDeployment', blueGreenDeployment_switchoverDetails - The details about each source and target resource in the blue/green deployment.

$sel:tagList:BlueGreenDeployment', blueGreenDeployment_tagList - Undocumented member.

$sel:target:BlueGreenDeployment', blueGreenDeployment_target - The target database for the blue/green deployment.

Before switchover, the target database is the clone database in the green environment.

$sel:tasks:BlueGreenDeployment', blueGreenDeployment_tasks - Either tasks to be performed or tasks that have been completed on the target database before switchover.

blueGreenDeployment_blueGreenDeploymentIdentifier :: Lens' BlueGreenDeployment (Maybe Text) Source #

The system-generated identifier of the blue/green deployment.

blueGreenDeployment_blueGreenDeploymentName :: Lens' BlueGreenDeployment (Maybe Text) Source #

The user-supplied name of the blue/green deployment.

blueGreenDeployment_createTime :: Lens' BlueGreenDeployment (Maybe UTCTime) Source #

Specifies the time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

blueGreenDeployment_deleteTime :: Lens' BlueGreenDeployment (Maybe UTCTime) Source #

Specifies the time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).

blueGreenDeployment_source :: Lens' BlueGreenDeployment (Maybe Text) Source #

The source database for the blue/green deployment.

Before switchover, the source database is the production database in the blue environment.

blueGreenDeployment_status :: Lens' BlueGreenDeployment (Maybe Text) Source #

The status of the blue/green deployment.

Values:

  • PROVISIONING - Resources are being created in the green environment.
  • AVAILABLE - Resources are available in the green environment.
  • SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the green environment.
  • SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.
  • INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.
  • SWITCHOVER_FAILED - Switchover was attempted but failed.
  • DELETING - The blue/green deployment is being deleted.

blueGreenDeployment_statusDetails :: Lens' BlueGreenDeployment (Maybe Text) Source #

Additional information about the status of the blue/green deployment.

blueGreenDeployment_switchoverDetails :: Lens' BlueGreenDeployment (Maybe [SwitchoverDetail]) Source #

The details about each source and target resource in the blue/green deployment.

blueGreenDeployment_target :: Lens' BlueGreenDeployment (Maybe Text) Source #

The target database for the blue/green deployment.

Before switchover, the target database is the clone database in the green environment.

blueGreenDeployment_tasks :: Lens' BlueGreenDeployment (Maybe [BlueGreenDeploymentTask]) Source #

Either tasks to be performed or tasks that have been completed on the target database before switchover.

BlueGreenDeploymentTask

data BlueGreenDeploymentTask Source #

Contains the details about a task for a blue/green deployment.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

See: newBlueGreenDeploymentTask smart constructor.

Constructors

BlueGreenDeploymentTask' 

Fields

  • name :: Maybe Text

    The name of the blue/green deployment task.

  • status :: Maybe Text

    The status of the blue/green deployment task.

    Values:

    • PENDING - The resources are being prepared for deployment.
    • IN_PROGRESS - The resource is being deployed.
    • COMPLETED - The resource has been deployed.
    • FAILED - Deployment of the resource failed.

Instances

Instances details
FromXML BlueGreenDeploymentTask Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeploymentTask

Generic BlueGreenDeploymentTask Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeploymentTask

Associated Types

type Rep BlueGreenDeploymentTask :: Type -> Type #

Read BlueGreenDeploymentTask Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeploymentTask

Show BlueGreenDeploymentTask Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeploymentTask

NFData BlueGreenDeploymentTask Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeploymentTask

Methods

rnf :: BlueGreenDeploymentTask -> () #

Eq BlueGreenDeploymentTask Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeploymentTask

Hashable BlueGreenDeploymentTask Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeploymentTask

type Rep BlueGreenDeploymentTask Source # 
Instance details

Defined in Amazonka.RDS.Types.BlueGreenDeploymentTask

type Rep BlueGreenDeploymentTask = D1 ('MetaData "BlueGreenDeploymentTask" "Amazonka.RDS.Types.BlueGreenDeploymentTask" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "BlueGreenDeploymentTask'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newBlueGreenDeploymentTask :: BlueGreenDeploymentTask Source #

Create a value of BlueGreenDeploymentTask with all optional fields omitted.

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

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

$sel:name:BlueGreenDeploymentTask', blueGreenDeploymentTask_name - The name of the blue/green deployment task.

$sel:status:BlueGreenDeploymentTask', blueGreenDeploymentTask_status - The status of the blue/green deployment task.

Values:

  • PENDING - The resources are being prepared for deployment.
  • IN_PROGRESS - The resource is being deployed.
  • COMPLETED - The resource has been deployed.
  • FAILED - Deployment of the resource failed.

blueGreenDeploymentTask_name :: Lens' BlueGreenDeploymentTask (Maybe Text) Source #

The name of the blue/green deployment task.

blueGreenDeploymentTask_status :: Lens' BlueGreenDeploymentTask (Maybe Text) Source #

The status of the blue/green deployment task.

Values:

  • PENDING - The resources are being prepared for deployment.
  • IN_PROGRESS - The resource is being deployed.
  • COMPLETED - The resource has been deployed.
  • FAILED - Deployment of the resource failed.

Certificate

data Certificate Source #

A CA certificate for an Amazon Web Services account.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

See: newCertificate smart constructor.

Constructors

Certificate' 

Fields

Instances

Instances details
FromXML Certificate Source # 
Instance details

Defined in Amazonka.RDS.Types.Certificate

Generic Certificate Source # 
Instance details

Defined in Amazonka.RDS.Types.Certificate

Associated Types

type Rep Certificate :: Type -> Type #

Read Certificate Source # 
Instance details

Defined in Amazonka.RDS.Types.Certificate

Show Certificate Source # 
Instance details

Defined in Amazonka.RDS.Types.Certificate

NFData Certificate Source # 
Instance details

Defined in Amazonka.RDS.Types.Certificate

Methods

rnf :: Certificate -> () #

Eq Certificate Source # 
Instance details

Defined in Amazonka.RDS.Types.Certificate

Hashable Certificate Source # 
Instance details

Defined in Amazonka.RDS.Types.Certificate

type Rep Certificate Source # 
Instance details

Defined in Amazonka.RDS.Types.Certificate

type Rep Certificate = D1 ('MetaData "Certificate" "Amazonka.RDS.Types.Certificate" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "Certificate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "certificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "certificateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customerOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "customerOverrideValidTill") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "thumbprint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "validFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "validTill") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))))

newCertificate :: Certificate Source #

Create a value of Certificate with all optional fields omitted.

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

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

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

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

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

$sel:customerOverride:Certificate', certificate_customerOverride - Whether there is an override for the default certificate identifier.

$sel:customerOverrideValidTill:Certificate', certificate_customerOverrideValidTill - If there is an override for the default certificate identifier, when the override expires.

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

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

$sel:validTill:Certificate', certificate_validTill - The final date that the certificate continues to be valid.

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

The Amazon Resource Name (ARN) for the certificate.

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

The unique key that identifies a certificate.

certificate_customerOverride :: Lens' Certificate (Maybe Bool) Source #

Whether there is an override for the default certificate identifier.

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

If there is an override for the default certificate identifier, when the override expires.

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

The thumbprint of the certificate.

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

The starting date from which the certificate is valid.

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

The final date that the certificate continues to be valid.

CertificateDetails

data CertificateDetails Source #

Returns the details of the DB instance’s server certificate.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

See: newCertificateDetails smart constructor.

Constructors

CertificateDetails' 

Fields

Instances

Instances details
FromXML CertificateDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.CertificateDetails

Generic CertificateDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.CertificateDetails

Associated Types

type Rep CertificateDetails :: Type -> Type #

Read CertificateDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.CertificateDetails

Show CertificateDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.CertificateDetails

NFData CertificateDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.CertificateDetails

Methods

rnf :: CertificateDetails -> () #

Eq CertificateDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.CertificateDetails

Hashable CertificateDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.CertificateDetails

type Rep CertificateDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.CertificateDetails

type Rep CertificateDetails = D1 ('MetaData "CertificateDetails" "Amazonka.RDS.Types.CertificateDetails" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "CertificateDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cAIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "validTill") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))

newCertificateDetails :: CertificateDetails Source #

Create a value of CertificateDetails with all optional fields omitted.

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

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

$sel:cAIdentifier:CertificateDetails', certificateDetails_cAIdentifier - The CA identifier of the CA certificate used for the DB instance's server certificate.

$sel:validTill:CertificateDetails', certificateDetails_validTill - The expiration date of the DB instance’s server certificate.

certificateDetails_cAIdentifier :: Lens' CertificateDetails (Maybe Text) Source #

The CA identifier of the CA certificate used for the DB instance's server certificate.

certificateDetails_validTill :: Lens' CertificateDetails (Maybe UTCTime) Source #

The expiration date of the DB instance’s server certificate.

CharacterSet

data CharacterSet Source #

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

See: newCharacterSet smart constructor.

Constructors

CharacterSet' 

Fields

Instances

Instances details
FromXML CharacterSet Source # 
Instance details

Defined in Amazonka.RDS.Types.CharacterSet

Generic CharacterSet Source # 
Instance details

Defined in Amazonka.RDS.Types.CharacterSet

Associated Types

type Rep CharacterSet :: Type -> Type #

Read CharacterSet Source # 
Instance details

Defined in Amazonka.RDS.Types.CharacterSet

Show CharacterSet Source # 
Instance details

Defined in Amazonka.RDS.Types.CharacterSet

NFData CharacterSet Source # 
Instance details

Defined in Amazonka.RDS.Types.CharacterSet

Methods

rnf :: CharacterSet -> () #

Eq CharacterSet Source # 
Instance details

Defined in Amazonka.RDS.Types.CharacterSet

Hashable CharacterSet Source # 
Instance details

Defined in Amazonka.RDS.Types.CharacterSet

type Rep CharacterSet Source # 
Instance details

Defined in Amazonka.RDS.Types.CharacterSet

type Rep CharacterSet = D1 ('MetaData "CharacterSet" "Amazonka.RDS.Types.CharacterSet" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "CharacterSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "characterSetDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "characterSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newCharacterSet :: CharacterSet Source #

Create a value of CharacterSet with all optional fields omitted.

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

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

$sel:characterSetDescription:CharacterSet', characterSet_characterSetDescription - The description of the character set.

$sel:characterSetName:CharacterSet', characterSet_characterSetName - The name of the character set.

characterSet_characterSetDescription :: Lens' CharacterSet (Maybe Text) Source #

The description of the character set.

CloudwatchLogsExportConfiguration

data CloudwatchLogsExportConfiguration Source #

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

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

For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

See: newCloudwatchLogsExportConfiguration smart constructor.

Constructors

CloudwatchLogsExportConfiguration' 

Fields

Instances

Instances details
ToQuery CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.CloudwatchLogsExportConfiguration

Generic CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.CloudwatchLogsExportConfiguration

Associated Types

type Rep CloudwatchLogsExportConfiguration :: Type -> Type #

Read CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.CloudwatchLogsExportConfiguration

Show CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.CloudwatchLogsExportConfiguration

NFData CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.CloudwatchLogsExportConfiguration

Eq CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.CloudwatchLogsExportConfiguration

Hashable CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.CloudwatchLogsExportConfiguration

type Rep CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.CloudwatchLogsExportConfiguration

type Rep CloudwatchLogsExportConfiguration = D1 ('MetaData "CloudwatchLogsExportConfiguration" "Amazonka.RDS.Types.CloudwatchLogsExportConfiguration" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "CloudwatchLogsExportConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "disableLogTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "enableLogTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newCloudwatchLogsExportConfiguration :: CloudwatchLogsExportConfiguration Source #

Create a value of CloudwatchLogsExportConfiguration with all optional fields omitted.

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

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

$sel:disableLogTypes:CloudwatchLogsExportConfiguration', cloudwatchLogsExportConfiguration_disableLogTypes - The list of log types to disable.

$sel:enableLogTypes:CloudwatchLogsExportConfiguration', cloudwatchLogsExportConfiguration_enableLogTypes - The list of log types to enable.

ClusterPendingModifiedValues

data ClusterPendingModifiedValues Source #

This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

See: newClusterPendingModifiedValues smart constructor.

Constructors

ClusterPendingModifiedValues' 

Fields

Instances

Instances details
FromXML ClusterPendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.ClusterPendingModifiedValues

Generic ClusterPendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.ClusterPendingModifiedValues

Associated Types

type Rep ClusterPendingModifiedValues :: Type -> Type #

Read ClusterPendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.ClusterPendingModifiedValues

Show ClusterPendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.ClusterPendingModifiedValues

NFData ClusterPendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.ClusterPendingModifiedValues

Eq ClusterPendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.ClusterPendingModifiedValues

Hashable ClusterPendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.ClusterPendingModifiedValues

type Rep ClusterPendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.ClusterPendingModifiedValues

type Rep ClusterPendingModifiedValues = D1 ('MetaData "ClusterPendingModifiedValues" "Amazonka.RDS.Types.ClusterPendingModifiedValues" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ClusterPendingModifiedValues'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "iAMDatabaseAuthenticationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "masterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pendingCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PendingCloudwatchLogsExports))))))

newClusterPendingModifiedValues :: ClusterPendingModifiedValues Source #

Create a value of ClusterPendingModifiedValues with all optional fields omitted.

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

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

$sel:allocatedStorage:ClusterPendingModifiedValues', clusterPendingModifiedValues_allocatedStorage - The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

$sel:backupRetentionPeriod:ClusterPendingModifiedValues', clusterPendingModifiedValues_backupRetentionPeriod - The number of days for which automatic DB snapshots are retained.

$sel:dbClusterIdentifier:ClusterPendingModifiedValues', clusterPendingModifiedValues_dbClusterIdentifier - The DBClusterIdentifier value for the DB cluster.

$sel:engineVersion:ClusterPendingModifiedValues', clusterPendingModifiedValues_engineVersion - The database engine version.

$sel:iAMDatabaseAuthenticationEnabled:ClusterPendingModifiedValues', clusterPendingModifiedValues_iAMDatabaseAuthenticationEnabled - A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

$sel:iops:ClusterPendingModifiedValues', clusterPendingModifiedValues_iops - The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:masterUserPassword:ClusterPendingModifiedValues', clusterPendingModifiedValues_masterUserPassword - The master credentials for the DB cluster.

$sel:pendingCloudwatchLogsExports:ClusterPendingModifiedValues', clusterPendingModifiedValues_pendingCloudwatchLogsExports - Undocumented member.

clusterPendingModifiedValues_allocatedStorage :: Lens' ClusterPendingModifiedValues (Maybe Int) Source #

The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

clusterPendingModifiedValues_backupRetentionPeriod :: Lens' ClusterPendingModifiedValues (Maybe Int) Source #

The number of days for which automatic DB snapshots are retained.

clusterPendingModifiedValues_iAMDatabaseAuthenticationEnabled :: Lens' ClusterPendingModifiedValues (Maybe Bool) Source #

A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

clusterPendingModifiedValues_iops :: Lens' ClusterPendingModifiedValues (Maybe Int) Source #

The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

ConnectionPoolConfiguration

data ConnectionPoolConfiguration Source #

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

See: newConnectionPoolConfiguration smart constructor.

Constructors

ConnectionPoolConfiguration' 

Fields

  • connectionBorrowTimeout :: Maybe Int

    The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

    Default: 120

    Constraints: between 1 and 3600, or 0 representing unlimited

  • initQuery :: Maybe Text

    One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

    Default: no initialization query

  • maxConnectionsPercent :: Maybe Int

    The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

    If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

    Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

    Constraints: Must be between 1 and 100.

  • maxIdleConnectionsPercent :: Maybe Int

    Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

    If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

    Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50.

    Constraints: Must be between 0 and the value of MaxConnectionsPercent.

  • sessionPinningFilters :: Maybe [Text]

    Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.

    Default: no session pinning filters

Instances

Instances details
ToQuery ConnectionPoolConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfiguration

Generic ConnectionPoolConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfiguration

Associated Types

type Rep ConnectionPoolConfiguration :: Type -> Type #

Read ConnectionPoolConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfiguration

Show ConnectionPoolConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfiguration

NFData ConnectionPoolConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfiguration

Eq ConnectionPoolConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfiguration

Hashable ConnectionPoolConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfiguration

type Rep ConnectionPoolConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfiguration

type Rep ConnectionPoolConfiguration = D1 ('MetaData "ConnectionPoolConfiguration" "Amazonka.RDS.Types.ConnectionPoolConfiguration" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ConnectionPoolConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "connectionBorrowTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "initQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxConnectionsPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "maxIdleConnectionsPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "sessionPinningFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newConnectionPoolConfiguration :: ConnectionPoolConfiguration Source #

Create a value of ConnectionPoolConfiguration with all optional fields omitted.

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

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

$sel:connectionBorrowTimeout:ConnectionPoolConfiguration', connectionPoolConfiguration_connectionBorrowTimeout - The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

Default: 120

Constraints: between 1 and 3600, or 0 representing unlimited

$sel:initQuery:ConnectionPoolConfiguration', connectionPoolConfiguration_initQuery - One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

Default: no initialization query

$sel:maxConnectionsPercent:ConnectionPoolConfiguration', connectionPoolConfiguration_maxConnectionsPercent - The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

Constraints: Must be between 1 and 100.

$sel:maxIdleConnectionsPercent:ConnectionPoolConfiguration', connectionPoolConfiguration_maxIdleConnectionsPercent - Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50.

Constraints: Must be between 0 and the value of MaxConnectionsPercent.

$sel:sessionPinningFilters:ConnectionPoolConfiguration', connectionPoolConfiguration_sessionPinningFilters - Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.

Default: no session pinning filters

connectionPoolConfiguration_connectionBorrowTimeout :: Lens' ConnectionPoolConfiguration (Maybe Int) Source #

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

Default: 120

Constraints: between 1 and 3600, or 0 representing unlimited

connectionPoolConfiguration_initQuery :: Lens' ConnectionPoolConfiguration (Maybe Text) Source #

One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

Default: no initialization query

connectionPoolConfiguration_maxConnectionsPercent :: Lens' ConnectionPoolConfiguration (Maybe Int) Source #

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

Constraints: Must be between 1 and 100.

connectionPoolConfiguration_maxIdleConnectionsPercent :: Lens' ConnectionPoolConfiguration (Maybe Int) Source #

Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50.

Constraints: Must be between 0 and the value of MaxConnectionsPercent.

connectionPoolConfiguration_sessionPinningFilters :: Lens' ConnectionPoolConfiguration (Maybe [Text]) Source #

Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.

Default: no session pinning filters

ConnectionPoolConfigurationInfo

data ConnectionPoolConfigurationInfo Source #

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

See: newConnectionPoolConfigurationInfo smart constructor.

Constructors

ConnectionPoolConfigurationInfo' 

Fields

  • connectionBorrowTimeout :: Maybe Int

    The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

  • initQuery :: Maybe Text

    One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

  • maxConnectionsPercent :: Maybe Int

    The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

  • maxIdleConnectionsPercent :: Maybe Int

    Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

  • sessionPinningFilters :: Maybe [Text]

    Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

Instances

Instances details
FromXML ConnectionPoolConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

Generic ConnectionPoolConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

Associated Types

type Rep ConnectionPoolConfigurationInfo :: Type -> Type #

Read ConnectionPoolConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

Show ConnectionPoolConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

NFData ConnectionPoolConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

Eq ConnectionPoolConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

Hashable ConnectionPoolConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

type Rep ConnectionPoolConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

type Rep ConnectionPoolConfigurationInfo = D1 ('MetaData "ConnectionPoolConfigurationInfo" "Amazonka.RDS.Types.ConnectionPoolConfigurationInfo" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ConnectionPoolConfigurationInfo'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "connectionBorrowTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "initQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxConnectionsPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "maxIdleConnectionsPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "sessionPinningFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newConnectionPoolConfigurationInfo :: ConnectionPoolConfigurationInfo Source #

Create a value of ConnectionPoolConfigurationInfo with all optional fields omitted.

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

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

$sel:connectionBorrowTimeout:ConnectionPoolConfigurationInfo', connectionPoolConfigurationInfo_connectionBorrowTimeout - The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

$sel:initQuery:ConnectionPoolConfigurationInfo', connectionPoolConfigurationInfo_initQuery - One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

$sel:maxConnectionsPercent:ConnectionPoolConfigurationInfo', connectionPoolConfigurationInfo_maxConnectionsPercent - The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

$sel:maxIdleConnectionsPercent:ConnectionPoolConfigurationInfo', connectionPoolConfigurationInfo_maxIdleConnectionsPercent - Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

$sel:sessionPinningFilters:ConnectionPoolConfigurationInfo', connectionPoolConfigurationInfo_sessionPinningFilters - Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

connectionPoolConfigurationInfo_connectionBorrowTimeout :: Lens' ConnectionPoolConfigurationInfo (Maybe Int) Source #

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

connectionPoolConfigurationInfo_initQuery :: Lens' ConnectionPoolConfigurationInfo (Maybe Text) Source #

One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

connectionPoolConfigurationInfo_maxConnectionsPercent :: Lens' ConnectionPoolConfigurationInfo (Maybe Int) Source #

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

connectionPoolConfigurationInfo_maxIdleConnectionsPercent :: Lens' ConnectionPoolConfigurationInfo (Maybe Int) Source #

Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

connectionPoolConfigurationInfo_sessionPinningFilters :: Lens' ConnectionPoolConfigurationInfo (Maybe [Text]) Source #

Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

CustomDBEngineVersionAMI

data CustomDBEngineVersionAMI Source #

A value that indicates the AMI information.

See: newCustomDBEngineVersionAMI smart constructor.

Constructors

CustomDBEngineVersionAMI' 

Fields

Instances

Instances details
FromXML CustomDBEngineVersionAMI Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomDBEngineVersionAMI

Generic CustomDBEngineVersionAMI Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomDBEngineVersionAMI

Associated Types

type Rep CustomDBEngineVersionAMI :: Type -> Type #

Read CustomDBEngineVersionAMI Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomDBEngineVersionAMI

Show CustomDBEngineVersionAMI Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomDBEngineVersionAMI

NFData CustomDBEngineVersionAMI Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomDBEngineVersionAMI

Eq CustomDBEngineVersionAMI Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomDBEngineVersionAMI

Hashable CustomDBEngineVersionAMI Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomDBEngineVersionAMI

type Rep CustomDBEngineVersionAMI Source # 
Instance details

Defined in Amazonka.RDS.Types.CustomDBEngineVersionAMI

type Rep CustomDBEngineVersionAMI = D1 ('MetaData "CustomDBEngineVersionAMI" "Amazonka.RDS.Types.CustomDBEngineVersionAMI" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "CustomDBEngineVersionAMI'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newCustomDBEngineVersionAMI :: CustomDBEngineVersionAMI Source #

Create a value of CustomDBEngineVersionAMI with all optional fields omitted.

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

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

$sel:imageId:CustomDBEngineVersionAMI', customDBEngineVersionAMI_imageId - A value that indicates the ID of the AMI.

$sel:status:CustomDBEngineVersionAMI', customDBEngineVersionAMI_status - A value that indicates the status of a custom engine version (CEV).

customDBEngineVersionAMI_imageId :: Lens' CustomDBEngineVersionAMI (Maybe Text) Source #

A value that indicates the ID of the AMI.

customDBEngineVersionAMI_status :: Lens' CustomDBEngineVersionAMI (Maybe Text) Source #

A value that indicates the status of a custom engine version (CEV).

DBCluster

data DBCluster Source #

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

See: newDBCluster smart constructor.

Constructors

DBCluster' 

Fields

  • activityStreamKinesisStreamName :: Maybe Text

    The name of the Amazon Kinesis data stream used for the database activity stream.

  • activityStreamKmsKeyId :: Maybe Text

    The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

  • activityStreamMode :: Maybe ActivityStreamMode

    The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

  • activityStreamStatus :: Maybe ActivityStreamStatus

    The status of the database activity stream.

  • allocatedStorage :: Maybe Int

    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

  • associatedRoles :: Maybe [DBClusterRole]

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

  • autoMinorVersionUpgrade :: Maybe Bool

    A value that indicates that minor version patches are applied automatically.

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • automaticRestartTime :: Maybe ISO8601

    The time when a stopped DB cluster is restarted automatically.

  • availabilityZones :: Maybe [Text]

    Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

  • backtrackConsumedChangeRecords :: Maybe Integer

    The number of change records stored for Backtrack.

  • backtrackWindow :: Maybe Integer

    The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

  • backupRetentionPeriod :: Maybe Int

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

  • capacity :: Maybe Int

    The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.

    For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

  • characterSetName :: Maybe Text

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

  • cloneGroupId :: Maybe Text

    Identifies the clone group to which the DB cluster is associated.

  • clusterCreateTime :: Maybe ISO8601

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

  • copyTagsToSnapshot :: Maybe Bool

    Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

  • crossAccountClone :: Maybe Bool

    Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

  • customEndpoints :: Maybe [Text]

    Identifies all custom endpoints associated with the cluster.

  • dbClusterArn :: Maybe Text

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

  • dbClusterIdentifier :: Maybe Text

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

  • dbClusterInstanceClass :: Maybe Text

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

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • dbClusterMembers :: Maybe [DBClusterMember]

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

  • dbClusterOptionGroupMemberships :: Maybe [DBClusterOptionGroupStatus]

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

  • dbClusterParameterGroup :: Maybe Text

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

  • dbSubnetGroup :: Maybe Text

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

  • dbSystemId :: Maybe Text

    Reserved for future use.

  • databaseName :: Maybe Text

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

  • dbClusterResourceId :: Maybe Text

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

  • deletionProtection :: Maybe Bool

    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

  • domainMemberships :: Maybe [DomainMembership]

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

  • earliestBacktrackTime :: Maybe ISO8601

    The earliest time to which a DB cluster can be backtracked.

  • earliestRestorableTime :: Maybe ISO8601

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

  • enabledCloudwatchLogsExports :: Maybe [Text]

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

    Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

  • endpoint :: Maybe Text

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

  • engine :: Maybe Text

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

  • engineMode :: Maybe Text

    The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

    For more information, see CreateDBCluster.

  • engineVersion :: Maybe Text

    Indicates the database engine version.

  • globalWriteForwardingRequested :: Maybe Bool

    Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

  • globalWriteForwardingStatus :: Maybe WriteForwardingStatus

    Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

  • hostedZoneId :: Maybe Text

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

  • httpEndpointEnabled :: Maybe Bool

    A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.

    For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

  • iAMDatabaseAuthenticationEnabled :: Maybe Bool

    A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

  • iops :: Maybe Int

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

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • kmsKeyId :: Maybe Text

    If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

  • latestRestorableTime :: Maybe ISO8601

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

  • masterUserSecret :: Maybe MasterUserSecret

    Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

    For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

  • masterUsername :: Maybe Text

    Contains the master username for the DB cluster.

  • monitoringInterval :: Maybe Int

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • monitoringRoleArn :: Maybe Text

    The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • multiAZ :: Maybe Bool

    Specifies whether the DB cluster has instances in multiple Availability Zones.

  • networkType :: Maybe Text

    The network type of the DB instance.

    Valid values:

    • IPV4
    • DUAL

    The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

    For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

    This setting is only for Aurora DB clusters.

  • pendingModifiedValues :: Maybe ClusterPendingModifiedValues

    A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

  • percentProgress :: Maybe Text

    Specifies the progress of the operation as a percentage.

  • performanceInsightsEnabled :: Maybe Bool

    True if Performance Insights is enabled for the DB cluster, and otherwise false.

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • performanceInsightsKMSKeyId :: Maybe Text

    The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • performanceInsightsRetentionPeriod :: Maybe Int

    The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

    • 7
    • month * 31, where month is a number of months from 1-23
    • 731

    For example, the following values are valid:

    • 93 (3 months * 31)
    • 341 (11 months * 31)
    • 589 (19 months * 31)
    • 731

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • port :: Maybe Int

    Specifies the port that the database engine is listening on.

  • preferredBackupWindow :: Maybe Text

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

  • preferredMaintenanceWindow :: Maybe Text

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

  • publiclyAccessible :: Maybe Bool

    Specifies the accessibility options for the DB instance.

    When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    For more information, see CreateDBInstance.

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • readReplicaIdentifiers :: Maybe [Text]

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

  • readerEndpoint :: Maybe Text

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

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

  • replicationSourceIdentifier :: Maybe Text

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

  • scalingConfigurationInfo :: Maybe ScalingConfigurationInfo
     
  • serverlessV2ScalingConfiguration :: Maybe ServerlessV2ScalingConfigurationInfo
     
  • status :: Maybe Text

    Specifies the current state of this DB cluster.

  • storageEncrypted :: Maybe Bool

    Specifies whether the DB cluster is encrypted.

  • storageType :: Maybe Text

    The storage type associated with the DB cluster.

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • tagList :: Maybe [Tag]
     
  • vpcSecurityGroups :: Maybe [VpcSecurityGroupMembership]

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

Instances

Instances details
FromXML DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

Generic DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

Associated Types

type Rep DBCluster :: Type -> Type #

Read DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

Show DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

NFData DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

Methods

rnf :: DBCluster -> () #

Eq DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

Hashable DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

type Rep DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

type Rep DBCluster = D1 ('MetaData "DBCluster" "Amazonka.RDS.Types.DBCluster" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBCluster'" 'PrefixI 'True) ((((((S1 ('MetaSel ('Just "activityStreamKinesisStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "activityStreamKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "activityStreamMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamMode)) :*: S1 ('MetaSel ('Just "activityStreamStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamStatus)))) :*: ((S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "associatedRoles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterRole]))) :*: (S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "automaticRestartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))) :*: (((S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "backtrackConsumedChangeRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "backtrackWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "capacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "characterSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "cloneGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "clusterCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))) :*: ((((S1 ('MetaSel ('Just "crossAccountClone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "customEndpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "dbClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "dbClusterInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterMember]))) :*: (S1 ('MetaSel ('Just "dbClusterOptionGroupMemberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterOptionGroupStatus])) :*: (S1 ('MetaSel ('Just "dbClusterParameterGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbSubnetGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "dbSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbClusterResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "domainMemberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DomainMembership])) :*: S1 ('MetaSel ('Just "earliestBacktrackTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "earliestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "enabledCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))) :*: (((((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engineMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "globalWriteForwardingRequested") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "globalWriteForwardingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WriteForwardingStatus)) :*: S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "httpEndpointEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "iAMDatabaseAuthenticationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))) :*: (((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "latestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "masterUserSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MasterUserSecret)) :*: S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "monitoringInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "monitoringRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "networkType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pendingModifiedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterPendingModifiedValues))))))) :*: ((((S1 ('MetaSel ('Just "percentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "performanceInsightsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "performanceInsightsKMSKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "performanceInsightsRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "readReplicaIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))) :*: (((S1 ('MetaSel ('Just "readerEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "replicationSourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "scalingConfigurationInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScalingConfigurationInfo)) :*: S1 ('MetaSel ('Just "serverlessV2ScalingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerlessV2ScalingConfigurationInfo)))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "vpcSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpcSecurityGroupMembership]))))))))))

newDBCluster :: DBCluster Source #

Create a value of DBCluster with all optional fields omitted.

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

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

$sel:activityStreamKinesisStreamName:DBCluster', dbCluster_activityStreamKinesisStreamName - The name of the Amazon Kinesis data stream used for the database activity stream.

$sel:activityStreamKmsKeyId:DBCluster', dbCluster_activityStreamKmsKeyId - The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

$sel:activityStreamMode:DBCluster', dbCluster_activityStreamMode - The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

$sel:activityStreamStatus:DBCluster', dbCluster_activityStreamStatus - The status of the database activity stream.

DBCluster, dbCluster_allocatedStorage - For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

$sel:associatedRoles:DBCluster', dbCluster_associatedRoles - Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

$sel:autoMinorVersionUpgrade:DBCluster', dbCluster_autoMinorVersionUpgrade - A value that indicates that minor version patches are applied automatically.

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:automaticRestartTime:DBCluster', dbCluster_automaticRestartTime - The time when a stopped DB cluster is restarted automatically.

$sel:availabilityZones:DBCluster', dbCluster_availabilityZones - Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

$sel:backtrackConsumedChangeRecords:DBCluster', dbCluster_backtrackConsumedChangeRecords - The number of change records stored for Backtrack.

$sel:backtrackWindow:DBCluster', dbCluster_backtrackWindow - The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

DBCluster, dbCluster_backupRetentionPeriod - Specifies the number of days for which automatic DB snapshots are retained.

$sel:capacity:DBCluster', dbCluster_capacity - The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

$sel:characterSetName:DBCluster', dbCluster_characterSetName - If present, specifies the name of the character set that this cluster is associated with.

$sel:cloneGroupId:DBCluster', dbCluster_cloneGroupId - Identifies the clone group to which the DB cluster is associated.

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

$sel:copyTagsToSnapshot:DBCluster', dbCluster_copyTagsToSnapshot - Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

$sel:crossAccountClone:DBCluster', dbCluster_crossAccountClone - Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

$sel:customEndpoints:DBCluster', dbCluster_customEndpoints - Identifies all custom endpoints associated with the cluster.

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

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

$sel:dbClusterInstanceClass:DBCluster', dbCluster_dbClusterInstanceClass - The name of the compute and memory capacity class of the DB instance.

This setting is only for non-Aurora Multi-AZ DB clusters.

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

$sel:dbClusterOptionGroupMemberships:DBCluster', dbCluster_dbClusterOptionGroupMemberships - Provides the list of option group memberships for this DB cluster.

$sel:dbClusterParameterGroup:DBCluster', dbCluster_dbClusterParameterGroup - Specifies the name of the DB cluster parameter group for the DB cluster.

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

$sel:dbSystemId:DBCluster', dbCluster_dbSystemId - Reserved for future use.

$sel:databaseName:DBCluster', dbCluster_databaseName - 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.

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

$sel:deletionProtection:DBCluster', dbCluster_deletionProtection - Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

$sel:domainMemberships:DBCluster', dbCluster_domainMemberships - The Active Directory Domain membership records associated with the DB cluster.

$sel:earliestBacktrackTime:DBCluster', dbCluster_earliestBacktrackTime - The earliest time to which a DB cluster can be backtracked.

$sel:earliestRestorableTime:DBCluster', dbCluster_earliestRestorableTime - The earliest time to which a database can be restored with point-in-time restore.

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

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

$sel:endpoint:DBCluster', dbCluster_endpoint - Specifies the connection endpoint for the primary instance of the DB cluster.

$sel:engine:DBCluster', dbCluster_engine - The name of the database engine to be used for this DB cluster.

$sel:engineMode:DBCluster', dbCluster_engineMode - The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

DBCluster, dbCluster_engineVersion - Indicates the database engine version.

$sel:globalWriteForwardingRequested:DBCluster', dbCluster_globalWriteForwardingRequested - Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

$sel:globalWriteForwardingStatus:DBCluster', dbCluster_globalWriteForwardingStatus - Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

$sel:hostedZoneId:DBCluster', dbCluster_hostedZoneId - Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

$sel:httpEndpointEnabled:DBCluster', dbCluster_httpEndpointEnabled - A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

DBCluster, dbCluster_iAMDatabaseAuthenticationEnabled - A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

DBCluster, dbCluster_iops - The Provisioned IOPS (I/O operations per second) value.

This setting is only for non-Aurora Multi-AZ DB clusters.

DBCluster, dbCluster_kmsKeyId - If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

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

$sel:masterUserSecret:DBCluster', dbCluster_masterUserSecret - Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

$sel:masterUsername:DBCluster', dbCluster_masterUsername - Contains the master username for the DB cluster.

$sel:monitoringInterval:DBCluster', dbCluster_monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:monitoringRoleArn:DBCluster', dbCluster_monitoringRoleArn - The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

This setting is only for non-Aurora Multi-AZ DB clusters.

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

$sel:networkType:DBCluster', dbCluster_networkType - The network type of the DB instance.

Valid values:

  • IPV4
  • DUAL

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

This setting is only for Aurora DB clusters.

$sel:pendingModifiedValues:DBCluster', dbCluster_pendingModifiedValues - A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

$sel:percentProgress:DBCluster', dbCluster_percentProgress - Specifies the progress of the operation as a percentage.

$sel:performanceInsightsEnabled:DBCluster', dbCluster_performanceInsightsEnabled - True if Performance Insights is enabled for the DB cluster, and otherwise false.

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:performanceInsightsKMSKeyId:DBCluster', dbCluster_performanceInsightsKMSKeyId - The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:performanceInsightsRetentionPeriod:DBCluster', dbCluster_performanceInsightsRetentionPeriod - The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

  • 7
  • month * 31, where month is a number of months from 1-23
  • 731

For example, the following values are valid:

  • 93 (3 months * 31)
  • 341 (11 months * 31)
  • 589 (19 months * 31)
  • 731

This setting is only for non-Aurora Multi-AZ DB clusters.

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

$sel:preferredBackupWindow:DBCluster', dbCluster_preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

$sel:preferredMaintenanceWindow:DBCluster', dbCluster_preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

$sel:publiclyAccessible:DBCluster', dbCluster_publiclyAccessible - Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:readReplicaIdentifiers:DBCluster', dbCluster_readReplicaIdentifiers - Contains one or more identifiers of the read replicas associated with this DB cluster.

$sel:readerEndpoint:DBCluster', dbCluster_readerEndpoint - The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

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

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

$sel:scalingConfigurationInfo:DBCluster', dbCluster_scalingConfigurationInfo - Undocumented member.

$sel:serverlessV2ScalingConfiguration:DBCluster', dbCluster_serverlessV2ScalingConfiguration - Undocumented member.

DBCluster, dbCluster_status - Specifies the current state of this DB cluster.

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

$sel:storageType:DBCluster', dbCluster_storageType - The storage type associated with the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:tagList:DBCluster', dbCluster_tagList - Undocumented member.

$sel:vpcSecurityGroups:DBCluster', dbCluster_vpcSecurityGroups - Provides a list of VPC security groups that the DB cluster belongs to.

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

The name of the Amazon Kinesis data stream used for the database activity stream.

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

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

dbCluster_activityStreamMode :: Lens' DBCluster (Maybe ActivityStreamMode) Source #

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

dbCluster_activityStreamStatus :: Lens' DBCluster (Maybe ActivityStreamStatus) Source #

The status of the database activity stream.

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

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

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

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

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

A value that indicates that minor version patches are applied automatically.

This setting is only for non-Aurora Multi-AZ DB clusters.

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

The time when a stopped DB cluster is restarted automatically.

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

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

dbCluster_backtrackConsumedChangeRecords :: Lens' DBCluster (Maybe Integer) Source #

The number of change records stored for Backtrack.

dbCluster_backtrackWindow :: Lens' DBCluster (Maybe Integer) Source #

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

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

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

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

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

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

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

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

Identifies the clone group to which the DB cluster is associated.

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

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

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

Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

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

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

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

Identifies all custom endpoints associated with the cluster.

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

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

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

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

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

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

This setting is only for non-Aurora Multi-AZ DB clusters.

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

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

dbCluster_dbClusterOptionGroupMemberships :: Lens' DBCluster (Maybe [DBClusterOptionGroupStatus]) Source #

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

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

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

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

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

Reserved for future use.

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

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

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

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

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

dbCluster_domainMemberships :: Lens' DBCluster (Maybe [DomainMembership]) Source #

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

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

The earliest time to which a DB cluster can be backtracked.

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

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

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

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

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

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

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

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

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

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

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

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

Indicates the database engine version.

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

Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

dbCluster_globalWriteForwardingStatus :: Lens' DBCluster (Maybe WriteForwardingStatus) Source #

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

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

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

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

A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

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

A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

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

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

This setting is only for non-Aurora Multi-AZ DB clusters.

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

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

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

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

dbCluster_masterUserSecret :: Lens' DBCluster (Maybe MasterUserSecret) Source #

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

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

Contains the master username for the DB cluster.

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

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

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

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

This setting is only for non-Aurora Multi-AZ DB clusters.

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

Specifies whether the DB cluster has instances in multiple Availability Zones.

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

The network type of the DB instance.

Valid values:

  • IPV4
  • DUAL

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

This setting is only for Aurora DB clusters.

dbCluster_pendingModifiedValues :: Lens' DBCluster (Maybe ClusterPendingModifiedValues) Source #

A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

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

Specifies the progress of the operation as a percentage.

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

True if Performance Insights is enabled for the DB cluster, and otherwise false.

This setting is only for non-Aurora Multi-AZ DB clusters.

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

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

This setting is only for non-Aurora Multi-AZ DB clusters.

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

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

  • 7
  • month * 31, where month is a number of months from 1-23
  • 731

For example, the following values are valid:

  • 93 (3 months * 31)
  • 341 (11 months * 31)
  • 589 (19 months * 31)
  • 731

This setting is only for non-Aurora Multi-AZ DB clusters.

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

Specifies the port that the database engine is listening on.

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

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

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

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

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

Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

This setting is only for non-Aurora Multi-AZ DB clusters.

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

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

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

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

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

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

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

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

Specifies the current state of this DB cluster.

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

Specifies whether the DB cluster is encrypted.

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

The storage type associated with the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_tagList :: Lens' DBCluster (Maybe [Tag]) Source #

Undocumented member.

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

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

DBClusterBacktrack

data DBClusterBacktrack Source #

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

See: newDBClusterBacktrack smart constructor.

Constructors

DBClusterBacktrack' 

Fields

  • backtrackIdentifier :: Maybe Text

    Contains the backtrack identifier.

  • backtrackRequestCreationTime :: Maybe ISO8601

    The timestamp of the time at which the backtrack was requested.

  • backtrackTo :: Maybe ISO8601

    The timestamp of the time to which the DB cluster was backtracked.

  • backtrackedFrom :: Maybe ISO8601

    The timestamp of the time from which the DB cluster was backtracked.

  • dbClusterIdentifier :: Maybe Text

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

  • status :: Maybe Text

    The status of the backtrack. This property returns one of the following values:

    • applying - The backtrack is currently being applied to or rolled back from the DB cluster.
    • completed - The backtrack has successfully been applied to or rolled back from the DB cluster.
    • failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
    • pending - The backtrack is currently pending application to or rollback from the DB cluster.

Instances

Instances details
FromXML DBClusterBacktrack Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterBacktrack

Generic DBClusterBacktrack Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterBacktrack

Associated Types

type Rep DBClusterBacktrack :: Type -> Type #

Read DBClusterBacktrack Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterBacktrack

Show DBClusterBacktrack Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterBacktrack

NFData DBClusterBacktrack Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterBacktrack

Methods

rnf :: DBClusterBacktrack -> () #

Eq DBClusterBacktrack Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterBacktrack

Hashable DBClusterBacktrack Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterBacktrack

type Rep DBClusterBacktrack Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterBacktrack

type Rep DBClusterBacktrack = D1 ('MetaData "DBClusterBacktrack" "Amazonka.RDS.Types.DBClusterBacktrack" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBClusterBacktrack'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "backtrackIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "backtrackRequestCreationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "backtrackTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :*: (S1 ('MetaSel ('Just "backtrackedFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDBClusterBacktrack :: DBClusterBacktrack Source #

Create a value of DBClusterBacktrack with all optional fields omitted.

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

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

$sel:backtrackIdentifier:DBClusterBacktrack', dbClusterBacktrack_backtrackIdentifier - Contains the backtrack identifier.

$sel:backtrackRequestCreationTime:DBClusterBacktrack', dbClusterBacktrack_backtrackRequestCreationTime - The timestamp of the time at which the backtrack was requested.

$sel:backtrackTo:DBClusterBacktrack', dbClusterBacktrack_backtrackTo - The timestamp of the time to which the DB cluster was backtracked.

$sel:backtrackedFrom:DBClusterBacktrack', dbClusterBacktrack_backtrackedFrom - The timestamp of the time from which the DB cluster was backtracked.

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

$sel:status:DBClusterBacktrack', dbClusterBacktrack_status - The status of the backtrack. This property returns one of the following values:

  • applying - The backtrack is currently being applied to or rolled back from the DB cluster.
  • completed - The backtrack has successfully been applied to or rolled back from the DB cluster.
  • failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
  • pending - The backtrack is currently pending application to or rollback from the DB cluster.

dbClusterBacktrack_backtrackRequestCreationTime :: Lens' DBClusterBacktrack (Maybe UTCTime) Source #

The timestamp of the time at which the backtrack was requested.

dbClusterBacktrack_backtrackTo :: Lens' DBClusterBacktrack (Maybe UTCTime) Source #

The timestamp of the time to which the DB cluster was backtracked.

dbClusterBacktrack_backtrackedFrom :: Lens' DBClusterBacktrack (Maybe UTCTime) Source #

The timestamp of the time from which the DB cluster was backtracked.

dbClusterBacktrack_dbClusterIdentifier :: Lens' DBClusterBacktrack (Maybe Text) Source #

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

dbClusterBacktrack_status :: Lens' DBClusterBacktrack (Maybe Text) Source #

The status of the backtrack. This property returns one of the following values:

  • applying - The backtrack is currently being applied to or rolled back from the DB cluster.
  • completed - The backtrack has successfully been applied to or rolled back from the DB cluster.
  • failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
  • pending - The backtrack is currently pending application to or rollback from the DB cluster.

DBClusterEndpoint

data DBClusterEndpoint Source #

This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint
  • DescribeDBClusterEndpoints
  • ModifyDBClusterEndpoint
  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

See: newDBClusterEndpoint smart constructor.

Constructors

DBClusterEndpoint' 

Fields

  • customEndpointType :: Maybe Text

    The type associated with a custom endpoint. One of: READER, WRITER, ANY.

  • dbClusterEndpointArn :: Maybe Text

    The Amazon Resource Name (ARN) for the endpoint.

  • dbClusterEndpointIdentifier :: Maybe Text

    The identifier associated with the endpoint. This parameter is stored as a lowercase string.

  • dbClusterEndpointResourceIdentifier :: Maybe Text

    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

  • dbClusterIdentifier :: Maybe Text

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

  • endpoint :: Maybe Text

    The DNS address of the endpoint.

  • endpointType :: Maybe Text

    The type of the endpoint. One of: READER, WRITER, CUSTOM.

  • excludedMembers :: Maybe [Text]

    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

  • staticMembers :: Maybe [Text]

    List of DB instance identifiers that are part of the custom endpoint group.

  • status :: Maybe Text

    The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

Instances

Instances details
FromXML DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

Generic DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

Associated Types

type Rep DBClusterEndpoint :: Type -> Type #

Read DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

Show DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

NFData DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

Methods

rnf :: DBClusterEndpoint -> () #

Eq DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

Hashable DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

type Rep DBClusterEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterEndpoint

type Rep DBClusterEndpoint = D1 ('MetaData "DBClusterEndpoint" "Amazonka.RDS.Types.DBClusterEndpoint" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBClusterEndpoint'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "customEndpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterEndpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbClusterEndpointIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dbClusterEndpointResourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "excludedMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "staticMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newDBClusterEndpoint :: DBClusterEndpoint Source #

Create a value of DBClusterEndpoint with all optional fields omitted.

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

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

$sel:customEndpointType:DBClusterEndpoint', dbClusterEndpoint_customEndpointType - The type associated with a custom endpoint. One of: READER, WRITER, ANY.

$sel:dbClusterEndpointArn:DBClusterEndpoint', dbClusterEndpoint_dbClusterEndpointArn - The Amazon Resource Name (ARN) for the endpoint.

$sel:dbClusterEndpointIdentifier:DBClusterEndpoint', dbClusterEndpoint_dbClusterEndpointIdentifier - The identifier associated with the endpoint. This parameter is stored as a lowercase string.

$sel:dbClusterEndpointResourceIdentifier:DBClusterEndpoint', dbClusterEndpoint_dbClusterEndpointResourceIdentifier - A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

$sel:dbClusterIdentifier:DBClusterEndpoint', dbClusterEndpoint_dbClusterIdentifier - The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

$sel:endpoint:DBClusterEndpoint', dbClusterEndpoint_endpoint - The DNS address of the endpoint.

$sel:endpointType:DBClusterEndpoint', dbClusterEndpoint_endpointType - The type of the endpoint. One of: READER, WRITER, CUSTOM.

$sel:excludedMembers:DBClusterEndpoint', dbClusterEndpoint_excludedMembers - List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

$sel:staticMembers:DBClusterEndpoint', dbClusterEndpoint_staticMembers - List of DB instance identifiers that are part of the custom endpoint group.

$sel:status:DBClusterEndpoint', dbClusterEndpoint_status - The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

dbClusterEndpoint_customEndpointType :: Lens' DBClusterEndpoint (Maybe Text) Source #

The type associated with a custom endpoint. One of: READER, WRITER, ANY.

dbClusterEndpoint_dbClusterEndpointArn :: Lens' DBClusterEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) for the endpoint.

dbClusterEndpoint_dbClusterEndpointIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

dbClusterEndpoint_dbClusterEndpointResourceIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

dbClusterEndpoint_dbClusterIdentifier :: Lens' DBClusterEndpoint (Maybe Text) Source #

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

dbClusterEndpoint_endpoint :: Lens' DBClusterEndpoint (Maybe Text) Source #

The DNS address of the endpoint.

dbClusterEndpoint_endpointType :: Lens' DBClusterEndpoint (Maybe Text) Source #

The type of the endpoint. One of: READER, WRITER, CUSTOM.

dbClusterEndpoint_excludedMembers :: Lens' DBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

dbClusterEndpoint_staticMembers :: Lens' DBClusterEndpoint (Maybe [Text]) Source #

List of DB instance identifiers that are part of the custom endpoint group.

dbClusterEndpoint_status :: Lens' DBClusterEndpoint (Maybe Text) Source #

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

DBClusterMember

data DBClusterMember Source #

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

See: newDBClusterMember smart constructor.

Constructors

DBClusterMember' 

Fields

Instances

Instances details
FromXML DBClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterMember

Generic DBClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterMember

Associated Types

type Rep DBClusterMember :: Type -> Type #

Read DBClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterMember

Show DBClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterMember

NFData DBClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterMember

Methods

rnf :: DBClusterMember -> () #

Eq DBClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterMember

Hashable DBClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterMember

type Rep DBClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterMember

type Rep DBClusterMember = D1 ('MetaData "DBClusterMember" "Amazonka.RDS.Types.DBClusterMember" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBClusterMember'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbClusterParameterGroupStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "isClusterWriter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "promotionTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newDBClusterMember :: DBClusterMember Source #

Create a value of DBClusterMember with all optional fields omitted.

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

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

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

$sel:dbInstanceIdentifier:DBClusterMember', dbClusterMember_dbInstanceIdentifier - Specifies the instance identifier for this member of the DB cluster.

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

$sel:promotionTier:DBClusterMember', dbClusterMember_promotionTier - A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

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

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

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

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

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

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

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

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

DBClusterOptionGroupStatus

data DBClusterOptionGroupStatus Source #

Contains status information for a DB cluster option group.

See: newDBClusterOptionGroupStatus smart constructor.

Constructors

DBClusterOptionGroupStatus' 

Fields

Instances

Instances details
FromXML DBClusterOptionGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterOptionGroupStatus

Generic DBClusterOptionGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterOptionGroupStatus

Associated Types

type Rep DBClusterOptionGroupStatus :: Type -> Type #

Read DBClusterOptionGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterOptionGroupStatus

Show DBClusterOptionGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterOptionGroupStatus

NFData DBClusterOptionGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterOptionGroupStatus

Eq DBClusterOptionGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterOptionGroupStatus

Hashable DBClusterOptionGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterOptionGroupStatus

type Rep DBClusterOptionGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterOptionGroupStatus

type Rep DBClusterOptionGroupStatus = D1 ('MetaData "DBClusterOptionGroupStatus" "Amazonka.RDS.Types.DBClusterOptionGroupStatus" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBClusterOptionGroupStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterOptionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDBClusterOptionGroupStatus :: DBClusterOptionGroupStatus Source #

Create a value of DBClusterOptionGroupStatus with all optional fields omitted.

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

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

$sel:dbClusterOptionGroupName:DBClusterOptionGroupStatus', dbClusterOptionGroupStatus_dbClusterOptionGroupName - Specifies the name of the DB cluster option group.

$sel:status:DBClusterOptionGroupStatus', dbClusterOptionGroupStatus_status - Specifies the status of the DB cluster option group.

dbClusterOptionGroupStatus_status :: Lens' DBClusterOptionGroupStatus (Maybe Text) Source #

Specifies the status of the DB cluster option group.

DBClusterParameterGroup

data DBClusterParameterGroup Source #

Contains the details of an Amazon RDS DB cluster parameter group.

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

See: newDBClusterParameterGroup smart constructor.

Constructors

DBClusterParameterGroup' 

Fields

Instances

Instances details
FromXML DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroup

Generic DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroup

Associated Types

type Rep DBClusterParameterGroup :: Type -> Type #

Read DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroup

Show DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroup

NFData DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroup

Methods

rnf :: DBClusterParameterGroup -> () #

Eq DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroup

Hashable DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroup

type Rep DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroup

type Rep DBClusterParameterGroup = D1 ('MetaData "DBClusterParameterGroup" "Amazonka.RDS.Types.DBClusterParameterGroup" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBClusterParameterGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbClusterParameterGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDBClusterParameterGroup :: DBClusterParameterGroup Source #

Create a value of DBClusterParameterGroup with all optional fields omitted.

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

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

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

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

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

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

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

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

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

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

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

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

DBClusterParameterGroupNameMessage

data DBClusterParameterGroupNameMessage Source #

Constructors

DBClusterParameterGroupNameMessage' 

Fields

  • dbClusterParameterGroupName :: Maybe Text

    The name of the DB cluster parameter group.

    Constraints:

    • Must be 1 to 255 letters or numbers.
    • First character must be a letter
    • Can't end with a hyphen or contain two consecutive hyphens

    This value is stored as a lowercase string.

Instances

Instances details
FromXML DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroupNameMessage

Generic DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroupNameMessage

Associated Types

type Rep DBClusterParameterGroupNameMessage :: Type -> Type #

Read DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroupNameMessage

Show DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroupNameMessage

NFData DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroupNameMessage

Eq DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroupNameMessage

Hashable DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroupNameMessage

type Rep DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroupNameMessage

type Rep DBClusterParameterGroupNameMessage = D1 ('MetaData "DBClusterParameterGroupNameMessage" "Amazonka.RDS.Types.DBClusterParameterGroupNameMessage" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBClusterParameterGroupNameMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage Source #

Create a value of DBClusterParameterGroupNameMessage with all optional fields omitted.

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

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

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

Constraints:

  • Must be 1 to 255 letters or numbers.
  • First character must be a letter
  • Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

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

The name of the DB cluster parameter group.

Constraints:

  • Must be 1 to 255 letters or numbers.
  • First character must be a letter
  • Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

DBClusterRole

data DBClusterRole Source #

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

See: newDBClusterRole smart constructor.

Constructors

DBClusterRole' 

Fields

  • featureName :: Maybe Text

    The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

  • roleArn :: Maybe Text

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

  • status :: Maybe Text

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

    • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.
    • PENDING - the IAM role ARN is being associated with the DB cluster.
    • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.

Instances

Instances details
FromXML DBClusterRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterRole

Generic DBClusterRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterRole

Associated Types

type Rep DBClusterRole :: Type -> Type #

Read DBClusterRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterRole

Show DBClusterRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterRole

NFData DBClusterRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterRole

Methods

rnf :: DBClusterRole -> () #

Eq DBClusterRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterRole

Hashable DBClusterRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterRole

type Rep DBClusterRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterRole

type Rep DBClusterRole = D1 ('MetaData "DBClusterRole" "Amazonka.RDS.Types.DBClusterRole" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBClusterRole'" 'PrefixI 'True) (S1 ('MetaSel ('Just "featureName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDBClusterRole :: DBClusterRole Source #

Create a value of DBClusterRole with all optional fields omitted.

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

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

$sel:featureName:DBClusterRole', dbClusterRole_featureName - The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

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

$sel:status:DBClusterRole', dbClusterRole_status - Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

  • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.
  • PENDING - the IAM role ARN is being associated with the DB cluster.
  • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.

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

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

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

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

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

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

  • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.
  • PENDING - the IAM role ARN is being associated with the DB cluster.
  • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.

DBClusterSnapshot

data DBClusterSnapshot Source #

Contains the details for an Amazon RDS DB cluster snapshot

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

See: newDBClusterSnapshot smart constructor.

Constructors

DBClusterSnapshot' 

Fields

Instances

Instances details
FromXML DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshot

Generic DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshot

Associated Types

type Rep DBClusterSnapshot :: Type -> Type #

Read DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshot

Show DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshot

NFData DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshot

Methods

rnf :: DBClusterSnapshot -> () #

Eq DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshot

Hashable DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshot

type Rep DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshot

type Rep DBClusterSnapshot = D1 ('MetaData "DBClusterSnapshot" "Amazonka.RDS.Types.DBClusterSnapshot" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBClusterSnapshot'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "clusterCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterSnapshotArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dbSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "engineMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iAMDatabaseAuthenticationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))) :*: (((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "percentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "snapshotCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))) :*: ((S1 ('MetaSel ('Just "snapshotType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sourceDBClusterSnapshotArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newDBClusterSnapshot :: DBClusterSnapshot Source #

Create a value of DBClusterSnapshot with all optional fields omitted.

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

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

$sel:allocatedStorage:DBClusterSnapshot', dbClusterSnapshot_allocatedStorage - Specifies the allocated storage size in gibibytes (GiB).

$sel:availabilityZones:DBClusterSnapshot', dbClusterSnapshot_availabilityZones - Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

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

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

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

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

$sel:dbSystemId:DBClusterSnapshot', dbClusterSnapshot_dbSystemId - Reserved for future use.

$sel:engine:DBClusterSnapshot', dbClusterSnapshot_engine - Specifies the name of the database engine for this DB cluster snapshot.

$sel:engineMode:DBClusterSnapshot', dbClusterSnapshot_engineMode - Provides the engine mode of the database engine for this DB cluster snapshot.

$sel:engineVersion:DBClusterSnapshot', dbClusterSnapshot_engineVersion - Provides the version of the database engine for this DB cluster snapshot.

$sel:iAMDatabaseAuthenticationEnabled:DBClusterSnapshot', dbClusterSnapshot_iAMDatabaseAuthenticationEnabled - True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

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

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

$sel:licenseModel:DBClusterSnapshot', dbClusterSnapshot_licenseModel - Provides the license model information for this DB cluster snapshot.

$sel:masterUsername:DBClusterSnapshot', dbClusterSnapshot_masterUsername - Provides the master username for this DB cluster snapshot.

$sel:percentProgress:DBClusterSnapshot', dbClusterSnapshot_percentProgress - Specifies the percentage of the estimated data that has been transferred.

$sel:port:DBClusterSnapshot', dbClusterSnapshot_port - Specifies the port that the DB cluster was listening on at the time of the snapshot.

$sel:snapshotCreateTime:DBClusterSnapshot', dbClusterSnapshot_snapshotCreateTime - Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

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

$sel:sourceDBClusterSnapshotArn:DBClusterSnapshot', dbClusterSnapshot_sourceDBClusterSnapshotArn - If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

$sel:status:DBClusterSnapshot', dbClusterSnapshot_status - Specifies the status of this DB cluster snapshot. Valid statuses are the following:

  • available
  • copying
  • creating

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

$sel:tagList:DBClusterSnapshot', dbClusterSnapshot_tagList - Undocumented member.

$sel:vpcId:DBClusterSnapshot', dbClusterSnapshot_vpcId - Provides the VPC ID associated with the DB cluster snapshot.

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

Specifies the allocated storage size in gibibytes (GiB).

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

Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

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

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

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

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

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

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

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

Specifies the identifier for the DB cluster snapshot.

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

Specifies the name of the database engine for this DB cluster snapshot.

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

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

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

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

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

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

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

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

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

Provides the license model information for this DB cluster snapshot.

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

Provides the master username for this DB cluster snapshot.

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

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

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

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

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

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

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

Provides the type of the DB cluster snapshot.

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

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

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

Specifies the status of this DB cluster snapshot. Valid statuses are the following:

  • available
  • copying
  • creating

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

Specifies whether the DB cluster snapshot is encrypted.

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

Provides the VPC ID associated with the DB cluster snapshot.

DBClusterSnapshotAttribute

data DBClusterSnapshotAttribute Source #

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

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

See: newDBClusterSnapshotAttribute smart constructor.

Constructors

DBClusterSnapshotAttribute' 

Fields

  • attributeName :: Maybe Text

    The name of the manual DB cluster snapshot attribute.

    The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

  • attributeValues :: Maybe [Text]

    The value(s) for the manual DB cluster snapshot attribute.

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

Instances

Instances details
FromXML DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttribute

Generic DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttribute

Associated Types

type Rep DBClusterSnapshotAttribute :: Type -> Type #

Read DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttribute

Show DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttribute

NFData DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttribute

Eq DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttribute

Hashable DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttribute

type Rep DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttribute

type Rep DBClusterSnapshotAttribute = D1 ('MetaData "DBClusterSnapshotAttribute" "Amazonka.RDS.Types.DBClusterSnapshotAttribute" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBClusterSnapshotAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "attributeValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newDBClusterSnapshotAttribute :: DBClusterSnapshotAttribute Source #

Create a value of DBClusterSnapshotAttribute with all optional fields omitted.

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

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

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

The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

$sel:attributeValues:DBClusterSnapshotAttribute', dbClusterSnapshotAttribute_attributeValues - The value(s) for the manual DB cluster snapshot attribute.

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

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

The name of the manual DB cluster snapshot attribute.

The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

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

The value(s) for the manual DB cluster snapshot attribute.

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

DBClusterSnapshotAttributesResult

data DBClusterSnapshotAttributesResult Source #

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

See: newDBClusterSnapshotAttributesResult smart constructor.

Constructors

DBClusterSnapshotAttributesResult' 

Fields

Instances

Instances details
FromXML DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttributesResult

Generic DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttributesResult

Associated Types

type Rep DBClusterSnapshotAttributesResult :: Type -> Type #

Read DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttributesResult

Show DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttributesResult

NFData DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttributesResult

Eq DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttributesResult

Hashable DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttributesResult

type Rep DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterSnapshotAttributesResult

type Rep DBClusterSnapshotAttributesResult = D1 ('MetaData "DBClusterSnapshotAttributesResult" "Amazonka.RDS.Types.DBClusterSnapshotAttributesResult" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBClusterSnapshotAttributesResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshotAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterSnapshotAttribute])) :*: S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDBClusterSnapshotAttributesResult :: DBClusterSnapshotAttributesResult Source #

Create a value of DBClusterSnapshotAttributesResult with all optional fields omitted.

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

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

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

$sel:dbClusterSnapshotIdentifier:DBClusterSnapshotAttributesResult', dbClusterSnapshotAttributesResult_dbClusterSnapshotIdentifier - The identifier of the manual DB cluster snapshot that the attributes apply to.

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

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

DBEngineVersion

data DBEngineVersion Source #

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

See: newDBEngineVersion smart constructor.

Constructors

DBEngineVersion' 

Fields

Instances

Instances details
FromXML DBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.DBEngineVersion

Generic DBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.DBEngineVersion

Associated Types

type Rep DBEngineVersion :: Type -> Type #

Read DBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.DBEngineVersion

Show DBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.DBEngineVersion

NFData DBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.DBEngineVersion

Methods

rnf :: DBEngineVersion -> () #

Eq DBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.DBEngineVersion

Hashable DBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.DBEngineVersion

type Rep DBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.DBEngineVersion

type Rep DBEngineVersion = D1 ('MetaData "DBEngineVersion" "Amazonka.RDS.Types.DBEngineVersion" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBEngineVersion'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "customDBEngineVersionManifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbEngineDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "dbEngineMediaType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbEngineVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbEngineVersionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "databaseInstallationFilesS3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "databaseInstallationFilesS3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "defaultCharacterSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CharacterSet)) :*: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "exportableLogTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDBEngineVersionAMI)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: ((((S1 ('MetaSel ('Just "majorEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "supportedCACertificateIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "supportedCharacterSets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CharacterSet])))) :*: ((S1 ('MetaSel ('Just "supportedEngineModes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "supportedFeatureNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "supportedNcharCharacterSets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CharacterSet])) :*: S1 ('MetaSel ('Just "supportedTimezones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Timezone]))))) :*: (((S1 ('MetaSel ('Just "supportsBabelfish") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "supportsCertificateRotationWithoutRestart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "supportsGlobalDatabases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "supportsLogExportsToCloudwatchLogs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "supportsParallelQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "supportsReadReplica") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "validUpgradeTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UpgradeTarget]))))))))

newDBEngineVersion :: DBEngineVersion Source #

Create a value of DBEngineVersion with all optional fields omitted.

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

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

$sel:createTime:DBEngineVersion', dbEngineVersion_createTime - The creation time of the DB engine version.

$sel:customDBEngineVersionManifest:DBEngineVersion', dbEngineVersion_customDBEngineVersionManifest - JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.

$sel:dbEngineDescription:DBEngineVersion', dbEngineVersion_dbEngineDescription - The description of the database engine.

$sel:dbEngineMediaType:DBEngineVersion', dbEngineVersion_dbEngineMediaType - A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

$sel:dbEngineVersionArn:DBEngineVersion', dbEngineVersion_dbEngineVersionArn - The ARN of the custom engine version.

$sel:dbEngineVersionDescription:DBEngineVersion', dbEngineVersion_dbEngineVersionDescription - The description of the database engine version.

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

$sel:databaseInstallationFilesS3BucketName:DBEngineVersion', dbEngineVersion_databaseInstallationFilesS3BucketName - The name of the Amazon S3 bucket that contains your database installation files.

$sel:databaseInstallationFilesS3Prefix:DBEngineVersion', dbEngineVersion_databaseInstallationFilesS3Prefix - The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

$sel:defaultCharacterSet:DBEngineVersion', dbEngineVersion_defaultCharacterSet - The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

DBEngineVersion, dbEngineVersion_engine - The name of the database engine.

DBEngineVersion, dbEngineVersion_engineVersion - The version number of the database engine.

$sel:exportableLogTypes:DBEngineVersion', dbEngineVersion_exportableLogTypes - The types of logs that the database engine has available for export to CloudWatch Logs.

$sel:image:DBEngineVersion', dbEngineVersion_image - The EC2 image

$sel:kmsKeyId:DBEngineVersion', dbEngineVersion_kmsKeyId - The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

$sel:majorEngineVersion:DBEngineVersion', dbEngineVersion_majorEngineVersion - The major engine version of the CEV.

DBEngineVersion, dbEngineVersion_status - The status of the DB engine version, either available or deprecated.

$sel:supportedCACertificateIdentifiers:DBEngineVersion', dbEngineVersion_supportedCACertificateIdentifiers - A list of the supported CA certificate identifiers.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

$sel:supportedCharacterSets:DBEngineVersion', dbEngineVersion_supportedCharacterSets - A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

DBEngineVersion, dbEngineVersion_supportedEngineModes - A list of the supported DB engine modes.

$sel:supportedFeatureNames:DBEngineVersion', dbEngineVersion_supportedFeatureNames - A list of features supported by the DB engine.

The supported features vary by DB engine and DB engine version.

To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

The supported features are listed under SupportedFeatureNames in the output.

$sel:supportedNcharCharacterSets:DBEngineVersion', dbEngineVersion_supportedNcharCharacterSets - A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

$sel:supportedTimezones:DBEngineVersion', dbEngineVersion_supportedTimezones - A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

DBEngineVersion, dbEngineVersion_supportsBabelfish - A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

$sel:supportsCertificateRotationWithoutRestart:DBEngineVersion', dbEngineVersion_supportsCertificateRotationWithoutRestart - A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

DBEngineVersion, dbEngineVersion_supportsGlobalDatabases - A value that indicates whether you can use Aurora global databases with a specific DB engine version.

$sel:supportsLogExportsToCloudwatchLogs:DBEngineVersion', dbEngineVersion_supportsLogExportsToCloudwatchLogs - A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

DBEngineVersion, dbEngineVersion_supportsParallelQuery - A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

$sel:supportsReadReplica:DBEngineVersion', dbEngineVersion_supportsReadReplica - Indicates whether the database engine version supports read replicas.

$sel:tagList:DBEngineVersion', dbEngineVersion_tagList - Undocumented member.

$sel:validUpgradeTarget:DBEngineVersion', dbEngineVersion_validUpgradeTarget - A list of engine versions that this database engine version can be upgraded to.

dbEngineVersion_createTime :: Lens' DBEngineVersion (Maybe UTCTime) Source #

The creation time of the DB engine version.

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

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.

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

The description of the database engine.

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

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

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

The ARN of the custom engine version.

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

The description of the database engine version.

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

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

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

The name of the Amazon S3 bucket that contains your database installation files.

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

The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

dbEngineVersion_defaultCharacterSet :: Lens' DBEngineVersion (Maybe CharacterSet) Source #

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

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

The name of the database engine.

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

The version number of the database engine.

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

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

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

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

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

The major engine version of the CEV.

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

The status of the DB engine version, either available or deprecated.

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

A list of the supported CA certificate identifiers.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

dbEngineVersion_supportedCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet]) Source #

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

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

A list of the supported DB engine modes.

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

A list of features supported by the DB engine.

The supported features vary by DB engine and DB engine version.

To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

The supported features are listed under SupportedFeatureNames in the output.

dbEngineVersion_supportedNcharCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet]) Source #

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

dbEngineVersion_supportedTimezones :: Lens' DBEngineVersion (Maybe [Timezone]) Source #

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

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

A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

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

A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

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

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

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

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

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

A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

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

Indicates whether the database engine version supports read replicas.

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

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

DBInstance

data DBInstance Source #

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

See: newDBInstance smart constructor.

Constructors

DBInstance' 

Fields

  • activityStreamEngineNativeAuditFieldsIncluded :: Maybe Bool

    Indicates whether engine-native audit fields are included in the database activity stream.

  • activityStreamKinesisStreamName :: Maybe Text

    The name of the Amazon Kinesis data stream used for the database activity stream.

  • activityStreamKmsKeyId :: Maybe Text

    The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

  • activityStreamMode :: Maybe ActivityStreamMode

    The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.

  • activityStreamPolicyStatus :: Maybe ActivityStreamPolicyStatus

    The status of the policy state of the activity stream.

  • activityStreamStatus :: Maybe ActivityStreamStatus

    The status of the database activity stream.

  • allocatedStorage :: Maybe Int

    Specifies the allocated storage size specified in gibibytes (GiB).

  • associatedRoles :: Maybe [DBInstanceRole]

    The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

  • autoMinorVersionUpgrade :: Maybe Bool

    A value that indicates that minor version patches are applied automatically.

  • automaticRestartTime :: Maybe ISO8601

    The time when a stopped DB instance is restarted automatically.

  • automationMode :: Maybe AutomationMode

    The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

  • availabilityZone :: Maybe Text

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

  • awsBackupRecoveryPointArn :: Maybe Text

    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

  • backupRetentionPeriod :: Maybe Int

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

  • backupTarget :: Maybe Text

    Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

  • cACertificateIdentifier :: Maybe Text

    The identifier of the CA certificate for this DB instance.

    For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

  • certificateDetails :: Maybe CertificateDetails

    The details of the DB instance's server certificate.

  • characterSetName :: Maybe Text

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

  • copyTagsToSnapshot :: Maybe Bool

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

    Amazon Aurora

    Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

  • customIamInstanceProfile :: Maybe Text

    The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

    • The profile must exist in your account.
    • The profile must have an IAM role that Amazon EC2 has permissions to assume.
    • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

  • customerOwnedIpEnabled :: Maybe Bool

    Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

    A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

    For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

    For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

  • dbClusterIdentifier :: Maybe Text

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

  • dbInstanceArn :: Maybe Text

    The Amazon Resource Name (ARN) for the DB instance.

  • dbInstanceAutomatedBackupsReplications :: Maybe [DBInstanceAutomatedBackupsReplication]

    The list of replicated automated backups associated with the DB instance.

  • dbInstanceClass :: Maybe Text

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

  • dbInstanceIdentifier :: Maybe Text

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

  • dbInstanceStatus :: Maybe Text

    Specifies the current state of this database.

    For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

  • dbName :: Maybe Text

    The meaning of this parameter differs according to the database engine you use.

    MySQL, MariaDB, 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.

  • dbParameterGroups :: Maybe [DBParameterGroupStatus]

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

  • dbSecurityGroups :: Maybe [DBSecurityGroupMembership]

    A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

  • dbSubnetGroup :: Maybe DBSubnetGroup

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

  • dbSystemId :: Maybe Text

    The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.

  • dbInstancePort :: Maybe Int

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

  • dbiResourceId :: Maybe Text

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

  • deletionProtection :: Maybe Bool

    Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

  • domainMemberships :: Maybe [DomainMembership]

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

  • enabledCloudwatchLogsExports :: Maybe [Text]

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

    Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

  • endpoint :: Maybe Endpoint

    Specifies the connection endpoint.

    The endpoint might not be shown for instances whose status is creating.

  • engine :: Maybe Text

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

  • engineVersion :: Maybe Text

    Indicates the database engine version.

  • enhancedMonitoringResourceArn :: Maybe Text

    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

  • iAMDatabaseAuthenticationEnabled :: Maybe Bool

    True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    IAM database authentication can be enabled for the following database engines

    • For MySQL 5.6, minor version 5.6.34 or higher
    • For MySQL 5.7, minor version 5.7.16 or higher
    • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
  • instanceCreateTime :: Maybe ISO8601

    Provides the date and time the DB instance was created.

  • iops :: Maybe Int

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

  • kmsKeyId :: Maybe Text

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

    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

  • latestRestorableTime :: Maybe ISO8601

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

  • licenseModel :: Maybe Text

    License model information for this DB instance. This setting doesn't apply to RDS Custom.

  • listenerEndpoint :: Maybe Endpoint

    Specifies the listener connection endpoint for SQL Server Always On.

  • masterUserSecret :: Maybe MasterUserSecret

    Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

    For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

  • masterUsername :: Maybe Text

    Contains the master username for the DB instance.

  • maxAllocatedStorage :: Maybe Int

    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

  • monitoringInterval :: Maybe Int

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

  • monitoringRoleArn :: Maybe Text

    The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

  • multiAZ :: Maybe Bool

    Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

  • ncharCharacterSetName :: Maybe Text

    The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

  • networkType :: Maybe Text

    The network type of the DB instance.

    Valid values:

    • IPV4
    • DUAL

    The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

    For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.

  • optionGroupMemberships :: Maybe [OptionGroupMembership]

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

  • pendingModifiedValues :: Maybe PendingModifiedValues

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

  • performanceInsightsEnabled :: Maybe Bool

    True if Performance Insights is enabled for the DB instance, and otherwise false.

  • performanceInsightsKMSKeyId :: Maybe Text

    The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

  • performanceInsightsRetentionPeriod :: Maybe Int

    The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

    • 7
    • month * 31, where month is a number of months from 1-23
    • 731

    For example, the following values are valid:

    • 93 (3 months * 31)
    • 341 (11 months * 31)
    • 589 (19 months * 31)
    • 731
  • preferredBackupWindow :: Maybe Text

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

  • preferredMaintenanceWindow :: Maybe Text

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

  • processorFeatures :: Maybe [ProcessorFeature]

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

  • promotionTier :: Maybe Int

    A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

  • publiclyAccessible :: Maybe Bool

    Specifies the accessibility options for the DB instance.

    When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    For more information, see CreateDBInstance.

  • readReplicaDBClusterIdentifiers :: Maybe [Text]

    Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.

    Currently, each RDS DB instance can have only one Aurora read replica.

  • readReplicaDBInstanceIdentifiers :: Maybe [Text]

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

  • readReplicaSourceDBInstanceIdentifier :: Maybe Text

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

  • replicaMode :: Maybe ReplicaMode

    The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

    This attribute is only supported in RDS for Oracle.

  • resumeFullAutomationModeTime :: Maybe ISO8601

    The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

  • secondaryAvailabilityZone :: Maybe Text

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

  • statusInfos :: Maybe [DBInstanceStatusInfo]

    The status of a read replica. If the instance isn't a read replica, this is blank.

  • storageEncrypted :: Maybe Bool

    Specifies whether the DB instance is encrypted.

  • storageThroughput :: Maybe Int

    Specifies the storage throughput for the DB instance.

    This setting applies only to the gp3 storage type.

  • storageType :: Maybe Text

    Specifies the storage type associated with the DB instance.

  • tagList :: Maybe [Tag]
     
  • tdeCredentialArn :: Maybe Text

    The ARN from the key store with which the instance is associated for TDE encryption.

  • timezone :: Maybe Text

    The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

  • vpcSecurityGroups :: Maybe [VpcSecurityGroupMembership]

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

Instances

Instances details
FromXML DBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstance

Generic DBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstance

Associated Types

type Rep DBInstance :: Type -> Type #

Read DBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstance

Show DBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstance

NFData DBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstance

Methods

rnf :: DBInstance -> () #

Eq DBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstance

Hashable DBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstance

type Rep DBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstance

type Rep DBInstance = D1 ('MetaData "DBInstance" "Amazonka.RDS.Types.DBInstance" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBInstance'" 'PrefixI 'True) ((((((S1 ('MetaSel ('Just "activityStreamEngineNativeAuditFieldsIncluded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "activityStreamKinesisStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "activityStreamKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "activityStreamMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamMode)) :*: S1 ('MetaSel ('Just "activityStreamPolicyStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamPolicyStatus))))) :*: ((S1 ('MetaSel ('Just "activityStreamStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamStatus)) :*: S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "associatedRoles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBInstanceRole])) :*: (S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "automaticRestartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))))) :*: (((S1 ('MetaSel ('Just "automationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutomationMode)) :*: S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "awsBackupRecoveryPointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "backupTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "cACertificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "certificateDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateDetails))) :*: (S1 ('MetaSel ('Just "characterSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "customIamInstanceProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))) :*: ((((S1 ('MetaSel ('Just "customerOwnedIpEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dbInstanceAutomatedBackupsReplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBInstanceAutomatedBackupsReplication])) :*: S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbInstanceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dbParameterGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBParameterGroupStatus])) :*: S1 ('MetaSel ('Just "dbSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBSecurityGroupMembership])))))) :*: (((S1 ('MetaSel ('Just "dbSubnetGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBSubnetGroup)) :*: S1 ('MetaSel ('Just "dbSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbInstancePort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "dbiResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "domainMemberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DomainMembership])) :*: S1 ('MetaSel ('Just "enabledCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Endpoint)) :*: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))) :*: (((((S1 ('MetaSel ('Just "enhancedMonitoringResourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iAMDatabaseAuthenticationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "instanceCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "latestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "listenerEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Endpoint)) :*: (S1 ('MetaSel ('Just "masterUserSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MasterUserSecret)) :*: S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "maxAllocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "monitoringInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "monitoringRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "ncharCharacterSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "networkType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "optionGroupMemberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OptionGroupMembership]))) :*: (S1 ('MetaSel ('Just "pendingModifiedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PendingModifiedValues)) :*: (S1 ('MetaSel ('Just "performanceInsightsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "performanceInsightsKMSKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))) :*: ((((S1 ('MetaSel ('Just "performanceInsightsRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "processorFeatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProcessorFeature])) :*: S1 ('MetaSel ('Just "promotionTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: ((S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "readReplicaDBClusterIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "readReplicaDBInstanceIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "readReplicaSourceDBInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "replicaMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicaMode)))))) :*: (((S1 ('MetaSel ('Just "resumeFullAutomationModeTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "secondaryAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "statusInfos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBInstanceStatusInfo])) :*: (S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "storageThroughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: ((S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "tdeCredentialArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpcSecurityGroupMembership]))))))))))

newDBInstance :: DBInstance Source #

Create a value of DBInstance with all optional fields omitted.

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

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

$sel:activityStreamEngineNativeAuditFieldsIncluded:DBInstance', dbInstance_activityStreamEngineNativeAuditFieldsIncluded - Indicates whether engine-native audit fields are included in the database activity stream.

$sel:activityStreamKinesisStreamName:DBInstance', dbInstance_activityStreamKinesisStreamName - The name of the Amazon Kinesis data stream used for the database activity stream.

$sel:activityStreamKmsKeyId:DBInstance', dbInstance_activityStreamKmsKeyId - The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

$sel:activityStreamMode:DBInstance', dbInstance_activityStreamMode - The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.

$sel:activityStreamPolicyStatus:DBInstance', dbInstance_activityStreamPolicyStatus - The status of the policy state of the activity stream.

$sel:activityStreamStatus:DBInstance', dbInstance_activityStreamStatus - The status of the database activity stream.

DBInstance, dbInstance_allocatedStorage - Specifies the allocated storage size specified in gibibytes (GiB).

$sel:associatedRoles:DBInstance', dbInstance_associatedRoles - The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

$sel:autoMinorVersionUpgrade:DBInstance', dbInstance_autoMinorVersionUpgrade - A value that indicates that minor version patches are applied automatically.

$sel:automaticRestartTime:DBInstance', dbInstance_automaticRestartTime - The time when a stopped DB instance is restarted automatically.

DBInstance, dbInstance_automationMode - The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

$sel:availabilityZone:DBInstance', dbInstance_availabilityZone - Specifies the name of the Availability Zone the DB instance is located in.

$sel:awsBackupRecoveryPointArn:DBInstance', dbInstance_awsBackupRecoveryPointArn - The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

DBInstance, dbInstance_backupRetentionPeriod - Specifies the number of days for which automatic DB snapshots are retained.

$sel:backupTarget:DBInstance', dbInstance_backupTarget - Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

DBInstance, dbInstance_cACertificateIdentifier - The identifier of the CA certificate for this DB instance.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

$sel:certificateDetails:DBInstance', dbInstance_certificateDetails - The details of the DB instance's server certificate.

$sel:characterSetName:DBInstance', dbInstance_characterSetName - If present, specifies the name of the character set that this instance is associated with.

$sel:copyTagsToSnapshot:DBInstance', dbInstance_copyTagsToSnapshot - Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

$sel:customIamInstanceProfile:DBInstance', dbInstance_customIamInstanceProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.
  • The profile must have an IAM role that Amazon EC2 has permissions to assume.
  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

$sel:customerOwnedIpEnabled:DBInstance', dbInstance_customerOwnedIpEnabled - Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

$sel:dbClusterIdentifier:DBInstance', dbInstance_dbClusterIdentifier - 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.

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

$sel:dbInstanceAutomatedBackupsReplications:DBInstance', dbInstance_dbInstanceAutomatedBackupsReplications - The list of replicated automated backups associated with the DB instance.

DBInstance, dbInstance_dbInstanceClass - Contains the name of the compute and memory capacity class of the DB instance.

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

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

For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

$sel:dbName:DBInstance', dbInstance_dbName - The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, 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.

$sel:dbParameterGroups:DBInstance', dbInstance_dbParameterGroups - Provides the list of DB parameter groups applied to this DB instance.

$sel:dbSecurityGroups:DBInstance', dbInstance_dbSecurityGroups - A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

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

$sel:dbSystemId:DBInstance', dbInstance_dbSystemId - The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.

$sel:dbInstancePort:DBInstance', dbInstance_dbInstancePort - 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.

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

$sel:deletionProtection:DBInstance', dbInstance_deletionProtection - Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

$sel:domainMemberships:DBInstance', dbInstance_domainMemberships - The Active Directory Domain membership records associated with the DB instance.

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

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

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

The endpoint might not be shown for instances whose status is creating.

$sel:engine:DBInstance', dbInstance_engine - The name of the database engine to be used for this DB instance.

DBInstance, dbInstance_engineVersion - Indicates the database engine version.

$sel:enhancedMonitoringResourceArn:DBInstance', dbInstance_enhancedMonitoringResourceArn - The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

DBInstance, dbInstance_iAMDatabaseAuthenticationEnabled - True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher
  • For MySQL 5.7, minor version 5.7.16 or higher
  • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

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

DBInstance, dbInstance_iops - Specifies the Provisioned IOPS (I/O operations per second) value.

DBInstance, dbInstance_kmsKeyId - If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

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

DBInstance, dbInstance_licenseModel - License model information for this DB instance. This setting doesn't apply to RDS Custom.

$sel:listenerEndpoint:DBInstance', dbInstance_listenerEndpoint - Specifies the listener connection endpoint for SQL Server Always On.

$sel:masterUserSecret:DBInstance', dbInstance_masterUserSecret - Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

$sel:masterUsername:DBInstance', dbInstance_masterUsername - Contains the master username for the DB instance.

$sel:maxAllocatedStorage:DBInstance', dbInstance_maxAllocatedStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

$sel:monitoringInterval:DBInstance', dbInstance_monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

$sel:monitoringRoleArn:DBInstance', dbInstance_monitoringRoleArn - The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

DBInstance, dbInstance_multiAZ - Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

$sel:ncharCharacterSetName:DBInstance', dbInstance_ncharCharacterSetName - The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

$sel:networkType:DBInstance', dbInstance_networkType - The network type of the DB instance.

Valid values:

  • IPV4
  • DUAL

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.

$sel:optionGroupMemberships:DBInstance', dbInstance_optionGroupMemberships - Provides the list of option group memberships for this DB instance.

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

$sel:performanceInsightsEnabled:DBInstance', dbInstance_performanceInsightsEnabled - True if Performance Insights is enabled for the DB instance, and otherwise false.

$sel:performanceInsightsKMSKeyId:DBInstance', dbInstance_performanceInsightsKMSKeyId - The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

$sel:performanceInsightsRetentionPeriod:DBInstance', dbInstance_performanceInsightsRetentionPeriod - The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

  • 7
  • month * 31, where month is a number of months from 1-23
  • 731

For example, the following values are valid:

  • 93 (3 months * 31)
  • 341 (11 months * 31)
  • 589 (19 months * 31)
  • 731

$sel:preferredBackupWindow:DBInstance', dbInstance_preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

$sel:preferredMaintenanceWindow:DBInstance', dbInstance_preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

DBInstance, dbInstance_processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

$sel:promotionTier:DBInstance', dbInstance_promotionTier - A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

$sel:publiclyAccessible:DBInstance', dbInstance_publiclyAccessible - Specifies the accessibility options for the DB instance.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

$sel:readReplicaDBClusterIdentifiers:DBInstance', dbInstance_readReplicaDBClusterIdentifiers - Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

$sel:readReplicaDBInstanceIdentifiers:DBInstance', dbInstance_readReplicaDBInstanceIdentifiers - Contains one or more identifiers of the read replicas associated with this DB instance.

$sel:readReplicaSourceDBInstanceIdentifier:DBInstance', dbInstance_readReplicaSourceDBInstanceIdentifier - Contains the identifier of the source DB instance if this DB instance is a read replica.

$sel:replicaMode:DBInstance', dbInstance_replicaMode - The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

This attribute is only supported in RDS for Oracle.

DBInstance, dbInstance_resumeFullAutomationModeTime - The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

$sel:secondaryAvailabilityZone:DBInstance', dbInstance_secondaryAvailabilityZone - If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

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

$sel:storageEncrypted:DBInstance', dbInstance_storageEncrypted - Specifies whether the DB instance is encrypted.

DBInstance, dbInstance_storageThroughput - Specifies the storage throughput for the DB instance.

This setting applies only to the gp3 storage type.

DBInstance, dbInstance_storageType - Specifies the storage type associated with the DB instance.

$sel:tagList:DBInstance', dbInstance_tagList - Undocumented member.

$sel:tdeCredentialArn:DBInstance', dbInstance_tdeCredentialArn - The ARN from the key store with which the instance is associated for TDE encryption.

$sel:timezone:DBInstance', dbInstance_timezone - The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

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

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

Indicates whether engine-native audit fields are included in the database activity stream.

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

The name of the Amazon Kinesis data stream used for the database activity stream.

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

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

dbInstance_activityStreamMode :: Lens' DBInstance (Maybe ActivityStreamMode) Source #

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.

dbInstance_activityStreamPolicyStatus :: Lens' DBInstance (Maybe ActivityStreamPolicyStatus) Source #

The status of the policy state of the activity stream.

dbInstance_activityStreamStatus :: Lens' DBInstance (Maybe ActivityStreamStatus) Source #

The status of the database activity stream.

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

Specifies the allocated storage size specified in gibibytes (GiB).

dbInstance_associatedRoles :: Lens' DBInstance (Maybe [DBInstanceRole]) Source #

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

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

A value that indicates that minor version patches are applied automatically.

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

The time when a stopped DB instance is restarted automatically.

dbInstance_automationMode :: Lens' DBInstance (Maybe AutomationMode) Source #

The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

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

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

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

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

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

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

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

Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

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

The identifier of the CA certificate for this DB instance.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

dbInstance_certificateDetails :: Lens' DBInstance (Maybe CertificateDetails) Source #

The details of the DB instance's server certificate.

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

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

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

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

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

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.
  • The profile must have an IAM role that Amazon EC2 has permissions to assume.
  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

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

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

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

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

The Amazon Resource Name (ARN) for the DB instance.

dbInstance_dbInstanceAutomatedBackupsReplications :: Lens' DBInstance (Maybe [DBInstanceAutomatedBackupsReplication]) Source #

The list of replicated automated backups associated with the DB instance.

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

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

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

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

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

Specifies the current state of this database.

For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

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

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, 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.

dbInstance_dbParameterGroups :: Lens' DBInstance (Maybe [DBParameterGroupStatus]) Source #

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

dbInstance_dbSecurityGroups :: Lens' DBInstance (Maybe [DBSecurityGroupMembership]) Source #

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

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

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

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.

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

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

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

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

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

dbInstance_domainMemberships :: Lens' DBInstance (Maybe [DomainMembership]) Source #

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

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

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

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

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

Specifies the connection endpoint.

The endpoint might not be shown for instances whose status is creating.

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

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

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

Indicates the database engine version.

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

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

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

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher
  • For MySQL 5.7, minor version 5.7.16 or higher
  • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

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

Provides the date and time the DB instance was created.

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

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

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

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

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

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

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

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

License model information for this DB instance. This setting doesn't apply to RDS Custom.

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

Specifies the listener connection endpoint for SQL Server Always On.

dbInstance_masterUserSecret :: Lens' DBInstance (Maybe MasterUserSecret) Source #

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

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

Contains the master username for the DB instance.

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

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

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

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

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

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

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

Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

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

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

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

The network type of the DB instance.

Valid values:

  • IPV4
  • DUAL

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.

dbInstance_optionGroupMemberships :: Lens' DBInstance (Maybe [OptionGroupMembership]) Source #

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

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

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

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

True if Performance Insights is enabled for the DB instance, and otherwise false.

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

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

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

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

  • 7
  • month * 31, where month is a number of months from 1-23
  • 731

For example, the following values are valid:

  • 93 (3 months * 31)
  • 341 (11 months * 31)
  • 589 (19 months * 31)
  • 731

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

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

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

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

dbInstance_processorFeatures :: Lens' DBInstance (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

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

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

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

Specifies the accessibility options for the DB instance.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

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

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

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

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

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

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

dbInstance_replicaMode :: Lens' DBInstance (Maybe ReplicaMode) Source #

The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

This attribute is only supported in RDS for Oracle.

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

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

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

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

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

The status of a read replica. If the instance isn't a read replica, this is blank.

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

Specifies whether the DB instance is encrypted.

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

Specifies the storage throughput for the DB instance.

This setting applies only to the gp3 storage type.

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

Specifies the storage type associated with the DB instance.

dbInstance_tagList :: Lens' DBInstance (Maybe [Tag]) Source #

Undocumented member.

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

The ARN from the key store with which the instance is associated for TDE encryption.

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

The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

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

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

DBInstanceAutomatedBackup

data DBInstanceAutomatedBackup Source #

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

See: newDBInstanceAutomatedBackup smart constructor.

Constructors

DBInstanceAutomatedBackup' 

Fields

Instances

Instances details
FromXML DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

Generic DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

Associated Types

type Rep DBInstanceAutomatedBackup :: Type -> Type #

Read DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

Show DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

NFData DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

Eq DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

Hashable DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

type Rep DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

type Rep DBInstanceAutomatedBackup = D1 ('MetaData "DBInstanceAutomatedBackup" "Amazonka.RDS.Types.DBInstanceAutomatedBackup" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBInstanceAutomatedBackup'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "backupTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbInstanceAutomatedBackupsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbInstanceAutomatedBackupsReplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBInstanceAutomatedBackupsReplication]))))) :*: ((S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dbiResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "encrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "iAMDatabaseAuthenticationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "instanceCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))))) :*: (((S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "restoreWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RestoreWindow)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "storageThroughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tdeCredentialArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newDBInstanceAutomatedBackup :: DBInstanceAutomatedBackup Source #

Create a value of DBInstanceAutomatedBackup with all optional fields omitted.

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

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

$sel:allocatedStorage:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_allocatedStorage - Specifies the allocated storage size in gibibytes (GiB).

$sel:availabilityZone:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_availabilityZone - The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

$sel:backupRetentionPeriod:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_backupRetentionPeriod - The retention period for the automated backups.

$sel:backupTarget:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_backupTarget - Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

$sel:dbInstanceArn:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_dbInstanceArn - The Amazon Resource Name (ARN) for the automated backups.

DBInstanceAutomatedBackup, dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsArn - The Amazon Resource Name (ARN) for the replicated automated backups.

$sel:dbInstanceAutomatedBackupsReplications:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsReplications - The list of replications to different Amazon Web Services Regions associated with the automated backup.

$sel:dbInstanceIdentifier:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_dbInstanceIdentifier - The customer id of the instance that is/was associated with the automated backup.

$sel:dbiResourceId:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_dbiResourceId - The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

$sel:encrypted:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_encrypted - Specifies whether the automated backup is encrypted.

$sel:engine:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_engine - The name of the database engine for this automated backup.

$sel:engineVersion:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_engineVersion - The version of the database engine for the automated backup.

$sel:iAMDatabaseAuthenticationEnabled:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_iAMDatabaseAuthenticationEnabled - True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

$sel:instanceCreateTime:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_instanceCreateTime - Provides the date and time that the DB instance was created.

$sel:iops:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_iops - The IOPS (I/O operations per second) value for the automated backup.

$sel:kmsKeyId:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_kmsKeyId - The Amazon Web Services KMS key ID for an automated backup.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

$sel:licenseModel:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_licenseModel - License model information for the automated backup.

$sel:masterUsername:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_masterUsername - The license model of an automated backup.

$sel:optionGroupName:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_optionGroupName - The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

$sel:port:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_port - The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

$sel:region:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_region - The Amazon Web Services Region associated with the automated backup.

$sel:restoreWindow:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_restoreWindow - Earliest and latest time an instance can be restored to.

$sel:status:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_status - Provides a list of status information for an automated backup:

  • active - automated backups for current instances
  • retained - automated backups for deleted instances
  • creating - automated backups that are waiting for the first automated snapshot to be available.

$sel:storageThroughput:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_storageThroughput - Specifies the storage throughput for the automated backup.

$sel:storageType:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_storageType - Specifies the storage type associated with the automated backup.

$sel:tdeCredentialArn:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_tdeCredentialArn - The ARN from the key store with which the automated backup is associated for TDE encryption.

$sel:timezone:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_timezone - The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

$sel:vpcId:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_vpcId - Provides the VPC ID associated with the DB instance.

dbInstanceAutomatedBackup_allocatedStorage :: Lens' DBInstanceAutomatedBackup (Maybe Int) Source #

Specifies the allocated storage size in gibibytes (GiB).

dbInstanceAutomatedBackup_availabilityZone :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

dbInstanceAutomatedBackup_backupTarget :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

dbInstanceAutomatedBackup_dbInstanceArn :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the automated backups.

dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsArn :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the replicated automated backups.

dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsReplications :: Lens' DBInstanceAutomatedBackup (Maybe [DBInstanceAutomatedBackupsReplication]) Source #

The list of replications to different Amazon Web Services Regions associated with the automated backup.

dbInstanceAutomatedBackup_dbInstanceIdentifier :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The customer id of the instance that is/was associated with the automated backup.

dbInstanceAutomatedBackup_dbiResourceId :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

dbInstanceAutomatedBackup_encrypted :: Lens' DBInstanceAutomatedBackup (Maybe Bool) Source #

Specifies whether the automated backup is encrypted.

dbInstanceAutomatedBackup_engine :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The name of the database engine for this automated backup.

dbInstanceAutomatedBackup_engineVersion :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The version of the database engine for the automated backup.

dbInstanceAutomatedBackup_iAMDatabaseAuthenticationEnabled :: Lens' DBInstanceAutomatedBackup (Maybe Bool) Source #

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

dbInstanceAutomatedBackup_instanceCreateTime :: Lens' DBInstanceAutomatedBackup (Maybe UTCTime) Source #

Provides the date and time that the DB instance was created.

dbInstanceAutomatedBackup_iops :: Lens' DBInstanceAutomatedBackup (Maybe Int) Source #

The IOPS (I/O operations per second) value for the automated backup.

dbInstanceAutomatedBackup_kmsKeyId :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Amazon Web Services KMS key ID for an automated backup.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

dbInstanceAutomatedBackup_licenseModel :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

License model information for the automated backup.

dbInstanceAutomatedBackup_optionGroupName :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

dbInstanceAutomatedBackup_port :: Lens' DBInstanceAutomatedBackup (Maybe Int) Source #

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

dbInstanceAutomatedBackup_region :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Amazon Web Services Region associated with the automated backup.

dbInstanceAutomatedBackup_restoreWindow :: Lens' DBInstanceAutomatedBackup (Maybe RestoreWindow) Source #

Earliest and latest time an instance can be restored to.

dbInstanceAutomatedBackup_status :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

Provides a list of status information for an automated backup:

  • active - automated backups for current instances
  • retained - automated backups for deleted instances
  • creating - automated backups that are waiting for the first automated snapshot to be available.

dbInstanceAutomatedBackup_storageThroughput :: Lens' DBInstanceAutomatedBackup (Maybe Int) Source #

Specifies the storage throughput for the automated backup.

dbInstanceAutomatedBackup_storageType :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

Specifies the storage type associated with the automated backup.

dbInstanceAutomatedBackup_tdeCredentialArn :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The ARN from the key store with which the automated backup is associated for TDE encryption.

dbInstanceAutomatedBackup_timezone :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

dbInstanceAutomatedBackup_vpcId :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

Provides the VPC ID associated with the DB instance.

DBInstanceAutomatedBackupsReplication

data DBInstanceAutomatedBackupsReplication Source #

Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

See: newDBInstanceAutomatedBackupsReplication smart constructor.

Constructors

DBInstanceAutomatedBackupsReplication' 

Fields

Instances

Instances details
FromXML DBInstanceAutomatedBackupsReplication Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackupsReplication

Generic DBInstanceAutomatedBackupsReplication Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackupsReplication

Read DBInstanceAutomatedBackupsReplication Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackupsReplication

Show DBInstanceAutomatedBackupsReplication Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackupsReplication

NFData DBInstanceAutomatedBackupsReplication Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackupsReplication

Eq DBInstanceAutomatedBackupsReplication Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackupsReplication

Hashable DBInstanceAutomatedBackupsReplication Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackupsReplication

type Rep DBInstanceAutomatedBackupsReplication Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackupsReplication

type Rep DBInstanceAutomatedBackupsReplication = D1 ('MetaData "DBInstanceAutomatedBackupsReplication" "Amazonka.RDS.Types.DBInstanceAutomatedBackupsReplication" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBInstanceAutomatedBackupsReplication'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstanceAutomatedBackupsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDBInstanceAutomatedBackupsReplication :: DBInstanceAutomatedBackupsReplication Source #

Create a value of DBInstanceAutomatedBackupsReplication with all optional fields omitted.

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

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

$sel:dbInstanceAutomatedBackupsArn:DBInstanceAutomatedBackupsReplication', dbInstanceAutomatedBackupsReplication_dbInstanceAutomatedBackupsArn - The Amazon Resource Name (ARN) of the replicated automated backups.

DBInstanceRole

data DBInstanceRole Source #

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

See: newDBInstanceRole smart constructor.

Constructors

DBInstanceRole' 

Fields

  • featureName :: Maybe Text

    The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

  • roleArn :: Maybe Text

    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

  • status :: Maybe Text

    Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

    • ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
    • PENDING - the IAM role ARN is being associated with the DB instance.
    • INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.

Instances

Instances details
FromXML DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

Generic DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

Associated Types

type Rep DBInstanceRole :: Type -> Type #

Read DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

Show DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

NFData DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

Methods

rnf :: DBInstanceRole -> () #

Eq DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

Hashable DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

type Rep DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

type Rep DBInstanceRole = D1 ('MetaData "DBInstanceRole" "Amazonka.RDS.Types.DBInstanceRole" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBInstanceRole'" 'PrefixI 'True) (S1 ('MetaSel ('Just "featureName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDBInstanceRole :: DBInstanceRole Source #

Create a value of DBInstanceRole with all optional fields omitted.

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

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

$sel:featureName:DBInstanceRole', dbInstanceRole_featureName - The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

$sel:roleArn:DBInstanceRole', dbInstanceRole_roleArn - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

$sel:status:DBInstanceRole', dbInstanceRole_status - Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

  • ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
  • PENDING - the IAM role ARN is being associated with the DB instance.
  • INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.

dbInstanceRole_featureName :: Lens' DBInstanceRole (Maybe Text) Source #

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

dbInstanceRole_roleArn :: Lens' DBInstanceRole (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

dbInstanceRole_status :: Lens' DBInstanceRole (Maybe Text) Source #

Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

  • ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
  • PENDING - the IAM role ARN is being associated with the DB instance.
  • INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.

DBInstanceStatusInfo

data DBInstanceStatusInfo Source #

Provides a list of status information for a DB instance.

See: newDBInstanceStatusInfo smart constructor.

Constructors

DBInstanceStatusInfo' 

Fields

  • message :: Maybe Text

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

  • normal :: Maybe Bool

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

  • status :: Maybe Text

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

  • statusType :: Maybe Text

    This value is currently "read replication."

Instances

Instances details
FromXML DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceStatusInfo

Generic DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceStatusInfo

Associated Types

type Rep DBInstanceStatusInfo :: Type -> Type #

Read DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceStatusInfo

Show DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceStatusInfo

NFData DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceStatusInfo

Methods

rnf :: DBInstanceStatusInfo -> () #

Eq DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceStatusInfo

Hashable DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceStatusInfo

type Rep DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceStatusInfo

type Rep DBInstanceStatusInfo = D1 ('MetaData "DBInstanceStatusInfo" "Amazonka.RDS.Types.DBInstanceStatusInfo" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBInstanceStatusInfo'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "normal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "statusType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDBInstanceStatusInfo :: DBInstanceStatusInfo Source #

Create a value of DBInstanceStatusInfo with all optional fields omitted.

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

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

$sel:message:DBInstanceStatusInfo', dbInstanceStatusInfo_message - Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.

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

$sel:status:DBInstanceStatusInfo', dbInstanceStatusInfo_status - Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

$sel:statusType:DBInstanceStatusInfo', dbInstanceStatusInfo_statusType - This value is currently "read replication."

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

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

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

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

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

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

This value is currently "read replication."

DBParameterGroup

data DBParameterGroup Source #

Contains the details of an Amazon RDS DB parameter group.

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

See: newDBParameterGroup smart constructor.

Constructors

DBParameterGroup' 

Fields

Instances

Instances details
FromXML DBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroup

Generic DBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroup

Associated Types

type Rep DBParameterGroup :: Type -> Type #

Read DBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroup

Show DBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroup

NFData DBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroup

Methods

rnf :: DBParameterGroup -> () #

Eq DBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroup

Hashable DBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroup

type Rep DBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroup

type Rep DBParameterGroup = D1 ('MetaData "DBParameterGroup" "Amazonka.RDS.Types.DBParameterGroup" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBParameterGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbParameterGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDBParameterGroup :: DBParameterGroup Source #

Create a value of DBParameterGroup with all optional fields omitted.

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

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

$sel:dbParameterGroupArn:DBParameterGroup', dbParameterGroup_dbParameterGroupArn - The Amazon Resource Name (ARN) for the DB parameter group.

$sel:dbParameterGroupFamily:DBParameterGroup', dbParameterGroup_dbParameterGroupFamily - The name of the DB parameter group family that this DB parameter group is compatible with.

$sel:dbParameterGroupName:DBParameterGroup', dbParameterGroup_dbParameterGroupName - The name of the DB parameter group.

$sel:description:DBParameterGroup', dbParameterGroup_description - Provides the customer-specified description for this DB parameter group.

dbParameterGroup_dbParameterGroupArn :: Lens' DBParameterGroup (Maybe Text) Source #

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

dbParameterGroup_dbParameterGroupFamily :: Lens' DBParameterGroup (Maybe Text) Source #

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

dbParameterGroup_description :: Lens' DBParameterGroup (Maybe Text) Source #

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

DBParameterGroupNameMessage

data DBParameterGroupNameMessage Source #

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

See: newDBParameterGroupNameMessage smart constructor.

Constructors

DBParameterGroupNameMessage' 

Fields

Instances

Instances details
FromXML DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Generic DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Associated Types

type Rep DBParameterGroupNameMessage :: Type -> Type #

Read DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Show DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

NFData DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Eq DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Hashable DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

type Rep DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

type Rep DBParameterGroupNameMessage = D1 ('MetaData "DBParameterGroupNameMessage" "Amazonka.RDS.Types.DBParameterGroupNameMessage" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBParameterGroupNameMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDBParameterGroupNameMessage :: DBParameterGroupNameMessage Source #

Create a value of DBParameterGroupNameMessage with all optional fields omitted.

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

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

$sel:dbParameterGroupName:DBParameterGroupNameMessage', dbParameterGroupNameMessage_dbParameterGroupName - 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: newDBParameterGroupStatus smart constructor.

Constructors

DBParameterGroupStatus' 

Fields

Instances

Instances details
FromXML DBParameterGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupStatus

Generic DBParameterGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupStatus

Associated Types

type Rep DBParameterGroupStatus :: Type -> Type #

Read DBParameterGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupStatus

Show DBParameterGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupStatus

NFData DBParameterGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupStatus

Methods

rnf :: DBParameterGroupStatus -> () #

Eq DBParameterGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupStatus

Hashable DBParameterGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupStatus

type Rep DBParameterGroupStatus Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupStatus

type Rep DBParameterGroupStatus = D1 ('MetaData "DBParameterGroupStatus" "Amazonka.RDS.Types.DBParameterGroupStatus" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBParameterGroupStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "parameterApplyStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDBParameterGroupStatus :: DBParameterGroupStatus Source #

Create a value of DBParameterGroupStatus with all optional fields omitted.

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

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

$sel:dbParameterGroupName:DBParameterGroupStatus', dbParameterGroupStatus_dbParameterGroupName - The name of the DB parameter group.

$sel:parameterApplyStatus:DBParameterGroupStatus', dbParameterGroupStatus_parameterApplyStatus - The status of parameter updates.

DBProxy

data DBProxy Source #

The data structure representing a proxy managed by the RDS Proxy.

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

See: newDBProxy smart constructor.

Constructors

DBProxy' 

Fields

  • auth :: Maybe [UserAuthConfigInfo]

    One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

  • createdDate :: Maybe ISO8601

    The date and time when the proxy was first created.

  • dbProxyArn :: Maybe Text

    The Amazon Resource Name (ARN) for the proxy.

  • dbProxyName :: Maybe Text

    The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • debugLogging :: Maybe Bool

    Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

  • endpoint :: Maybe Text

    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

  • engineFamily :: Maybe Text

    The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

  • idleClientTimeout :: Maybe Int

    The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

    Default: 1800 (30 minutes)

    Constraints: 1 to 28,800

  • requireTLS :: Maybe Bool

    Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

  • roleArn :: Maybe Text

    The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

  • status :: Maybe DBProxyStatus

    The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

  • updatedDate :: Maybe ISO8601

    The date and time when the proxy was last updated.

  • vpcId :: Maybe Text

    Provides the VPC ID of the DB proxy.

  • vpcSecurityGroupIds :: Maybe [Text]

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

  • vpcSubnetIds :: Maybe [Text]

    The EC2 subnet IDs for the proxy.

Instances

Instances details
FromXML DBProxy Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxy

Generic DBProxy Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxy

Associated Types

type Rep DBProxy :: Type -> Type #

Methods

from :: DBProxy -> Rep DBProxy x #

to :: Rep DBProxy x -> DBProxy #

Read DBProxy Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxy

Show DBProxy Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxy

NFData DBProxy Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxy

Methods

rnf :: DBProxy -> () #

Eq DBProxy Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxy

Methods

(==) :: DBProxy -> DBProxy -> Bool #

(/=) :: DBProxy -> DBProxy -> Bool #

Hashable DBProxy Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxy

Methods

hashWithSalt :: Int -> DBProxy -> Int #

hash :: DBProxy -> Int #

type Rep DBProxy Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxy

type Rep DBProxy = D1 ('MetaData "DBProxy" "Amazonka.RDS.Types.DBProxy" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBProxy'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "auth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserAuthConfigInfo])) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "dbProxyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "dbProxyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "debugLogging") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engineFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "idleClientTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "requireTLS") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBProxyStatus)))) :*: ((S1 ('MetaSel ('Just "updatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "vpcSubnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

newDBProxy :: DBProxy Source #

Create a value of DBProxy with all optional fields omitted.

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

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

$sel:auth:DBProxy', dbProxy_auth - One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

$sel:createdDate:DBProxy', dbProxy_createdDate - The date and time when the proxy was first created.

$sel:dbProxyArn:DBProxy', dbProxy_dbProxyArn - The Amazon Resource Name (ARN) for the proxy.

$sel:dbProxyName:DBProxy', dbProxy_dbProxyName - The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

$sel:debugLogging:DBProxy', dbProxy_debugLogging - Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

$sel:endpoint:DBProxy', dbProxy_endpoint - The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

$sel:engineFamily:DBProxy', dbProxy_engineFamily - The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

$sel:idleClientTimeout:DBProxy', dbProxy_idleClientTimeout - The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

Default: 1800 (30 minutes)

Constraints: 1 to 28,800

$sel:requireTLS:DBProxy', dbProxy_requireTLS - Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

$sel:roleArn:DBProxy', dbProxy_roleArn - The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

$sel:status:DBProxy', dbProxy_status - The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

$sel:updatedDate:DBProxy', dbProxy_updatedDate - The date and time when the proxy was last updated.

$sel:vpcId:DBProxy', dbProxy_vpcId - Provides the VPC ID of the DB proxy.

$sel:vpcSecurityGroupIds:DBProxy', dbProxy_vpcSecurityGroupIds - Provides a list of VPC security groups that the proxy belongs to.

$sel:vpcSubnetIds:DBProxy', dbProxy_vpcSubnetIds - The EC2 subnet IDs for the proxy.

dbProxy_auth :: Lens' DBProxy (Maybe [UserAuthConfigInfo]) Source #

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

dbProxy_createdDate :: Lens' DBProxy (Maybe UTCTime) Source #

The date and time when the proxy was first created.

dbProxy_dbProxyArn :: Lens' DBProxy (Maybe Text) Source #

The Amazon Resource Name (ARN) for the proxy.

dbProxy_dbProxyName :: Lens' DBProxy (Maybe Text) Source #

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

dbProxy_debugLogging :: Lens' DBProxy (Maybe Bool) Source #

Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

dbProxy_endpoint :: Lens' DBProxy (Maybe Text) Source #

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

dbProxy_engineFamily :: Lens' DBProxy (Maybe Text) Source #

The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

dbProxy_idleClientTimeout :: Lens' DBProxy (Maybe Int) Source #

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

Default: 1800 (30 minutes)

Constraints: 1 to 28,800

dbProxy_requireTLS :: Lens' DBProxy (Maybe Bool) Source #

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

dbProxy_roleArn :: Lens' DBProxy (Maybe Text) Source #

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

dbProxy_status :: Lens' DBProxy (Maybe DBProxyStatus) Source #

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

dbProxy_updatedDate :: Lens' DBProxy (Maybe UTCTime) Source #

The date and time when the proxy was last updated.

dbProxy_vpcId :: Lens' DBProxy (Maybe Text) Source #

Provides the VPC ID of the DB proxy.

dbProxy_vpcSecurityGroupIds :: Lens' DBProxy (Maybe [Text]) Source #

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

dbProxy_vpcSubnetIds :: Lens' DBProxy (Maybe [Text]) Source #

The EC2 subnet IDs for the proxy.

DBProxyEndpoint

data DBProxyEndpoint Source #

The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.

This data type is used as a response element in the DescribeDBProxyEndpoints operation.

See: newDBProxyEndpoint smart constructor.

Constructors

DBProxyEndpoint' 

Fields

  • createdDate :: Maybe ISO8601

    The date and time when the DB proxy endpoint was first created.

  • dbProxyEndpointArn :: Maybe Text

    The Amazon Resource Name (ARN) for the DB proxy endpoint.

  • dbProxyEndpointName :: Maybe Text

    The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

  • dbProxyName :: Maybe Text

    The identifier for the DB proxy that is associated with this DB proxy endpoint.

  • endpoint :: Maybe Text

    The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

  • isDefault :: Maybe Bool

    A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

  • status :: Maybe DBProxyEndpointStatus

    The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

  • targetRole :: Maybe DBProxyEndpointTargetRole

    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

  • vpcId :: Maybe Text

    Provides the VPC ID of the DB proxy endpoint.

  • vpcSecurityGroupIds :: Maybe [Text]

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

  • vpcSubnetIds :: Maybe [Text]

    The EC2 subnet IDs for the DB proxy endpoint.

Instances

Instances details
FromXML DBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpoint

Generic DBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpoint

Associated Types

type Rep DBProxyEndpoint :: Type -> Type #

Read DBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpoint

Show DBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpoint

NFData DBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpoint

Methods

rnf :: DBProxyEndpoint -> () #

Eq DBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpoint

Hashable DBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpoint

type Rep DBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyEndpoint

type Rep DBProxyEndpoint = D1 ('MetaData "DBProxyEndpoint" "Amazonka.RDS.Types.DBProxyEndpoint" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBProxyEndpoint'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "dbProxyEndpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbProxyEndpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dbProxyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "isDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBProxyEndpointStatus)) :*: S1 ('MetaSel ('Just "targetRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBProxyEndpointTargetRole)))) :*: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "vpcSubnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

newDBProxyEndpoint :: DBProxyEndpoint Source #

Create a value of DBProxyEndpoint with all optional fields omitted.

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

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

$sel:createdDate:DBProxyEndpoint', dbProxyEndpoint_createdDate - The date and time when the DB proxy endpoint was first created.

$sel:dbProxyEndpointArn:DBProxyEndpoint', dbProxyEndpoint_dbProxyEndpointArn - The Amazon Resource Name (ARN) for the DB proxy endpoint.

$sel:dbProxyEndpointName:DBProxyEndpoint', dbProxyEndpoint_dbProxyEndpointName - The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

$sel:dbProxyName:DBProxyEndpoint', dbProxyEndpoint_dbProxyName - The identifier for the DB proxy that is associated with this DB proxy endpoint.

$sel:endpoint:DBProxyEndpoint', dbProxyEndpoint_endpoint - The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

$sel:isDefault:DBProxyEndpoint', dbProxyEndpoint_isDefault - A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

$sel:status:DBProxyEndpoint', dbProxyEndpoint_status - The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

$sel:targetRole:DBProxyEndpoint', dbProxyEndpoint_targetRole - A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

$sel:vpcId:DBProxyEndpoint', dbProxyEndpoint_vpcId - Provides the VPC ID of the DB proxy endpoint.

$sel:vpcSecurityGroupIds:DBProxyEndpoint', dbProxyEndpoint_vpcSecurityGroupIds - Provides a list of VPC security groups that the DB proxy endpoint belongs to.

$sel:vpcSubnetIds:DBProxyEndpoint', dbProxyEndpoint_vpcSubnetIds - The EC2 subnet IDs for the DB proxy endpoint.

dbProxyEndpoint_createdDate :: Lens' DBProxyEndpoint (Maybe UTCTime) Source #

The date and time when the DB proxy endpoint was first created.

dbProxyEndpoint_dbProxyEndpointArn :: Lens' DBProxyEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) for the DB proxy endpoint.

dbProxyEndpoint_dbProxyEndpointName :: Lens' DBProxyEndpoint (Maybe Text) Source #

The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

dbProxyEndpoint_dbProxyName :: Lens' DBProxyEndpoint (Maybe Text) Source #

The identifier for the DB proxy that is associated with this DB proxy endpoint.

dbProxyEndpoint_endpoint :: Lens' DBProxyEndpoint (Maybe Text) Source #

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

dbProxyEndpoint_isDefault :: Lens' DBProxyEndpoint (Maybe Bool) Source #

A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

dbProxyEndpoint_status :: Lens' DBProxyEndpoint (Maybe DBProxyEndpointStatus) Source #

The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

dbProxyEndpoint_targetRole :: Lens' DBProxyEndpoint (Maybe DBProxyEndpointTargetRole) Source #

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

dbProxyEndpoint_vpcId :: Lens' DBProxyEndpoint (Maybe Text) Source #

Provides the VPC ID of the DB proxy endpoint.

dbProxyEndpoint_vpcSecurityGroupIds :: Lens' DBProxyEndpoint (Maybe [Text]) Source #

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

dbProxyEndpoint_vpcSubnetIds :: Lens' DBProxyEndpoint (Maybe [Text]) Source #

The EC2 subnet IDs for the DB proxy endpoint.

DBProxyTarget

data DBProxyTarget Source #

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

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

See: newDBProxyTarget smart constructor.

Constructors

DBProxyTarget' 

Fields

  • endpoint :: Maybe Text

    The writer endpoint for the RDS DB instance or Aurora DB cluster.

  • port :: Maybe Int

    The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

  • rdsResourceId :: Maybe Text

    The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

  • role' :: Maybe TargetRole

    A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

  • targetArn :: Maybe Text

    The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

  • targetHealth :: Maybe TargetHealth

    Information about the connection health of the RDS Proxy target.

  • trackedClusterId :: Maybe Text

    The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

  • type' :: Maybe TargetType

    Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

Instances

Instances details
FromXML DBProxyTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTarget

Generic DBProxyTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTarget

Associated Types

type Rep DBProxyTarget :: Type -> Type #

Read DBProxyTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTarget

Show DBProxyTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTarget

NFData DBProxyTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTarget

Methods

rnf :: DBProxyTarget -> () #

Eq DBProxyTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTarget

Hashable DBProxyTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTarget

type Rep DBProxyTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTarget

newDBProxyTarget :: DBProxyTarget Source #

Create a value of DBProxyTarget with all optional fields omitted.

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

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

$sel:endpoint:DBProxyTarget', dbProxyTarget_endpoint - The writer endpoint for the RDS DB instance or Aurora DB cluster.

$sel:port:DBProxyTarget', dbProxyTarget_port - The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

$sel:rdsResourceId:DBProxyTarget', dbProxyTarget_rdsResourceId - The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

$sel:role':DBProxyTarget', dbProxyTarget_role - A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

$sel:targetArn:DBProxyTarget', dbProxyTarget_targetArn - The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

$sel:targetHealth:DBProxyTarget', dbProxyTarget_targetHealth - Information about the connection health of the RDS Proxy target.

$sel:trackedClusterId:DBProxyTarget', dbProxyTarget_trackedClusterId - The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

$sel:type':DBProxyTarget', dbProxyTarget_type - Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

dbProxyTarget_endpoint :: Lens' DBProxyTarget (Maybe Text) Source #

The writer endpoint for the RDS DB instance or Aurora DB cluster.

dbProxyTarget_port :: Lens' DBProxyTarget (Maybe Int) Source #

The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

dbProxyTarget_rdsResourceId :: Lens' DBProxyTarget (Maybe Text) Source #

The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

dbProxyTarget_role :: Lens' DBProxyTarget (Maybe TargetRole) Source #

A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

dbProxyTarget_targetArn :: Lens' DBProxyTarget (Maybe Text) Source #

The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

dbProxyTarget_targetHealth :: Lens' DBProxyTarget (Maybe TargetHealth) Source #

Information about the connection health of the RDS Proxy target.

dbProxyTarget_trackedClusterId :: Lens' DBProxyTarget (Maybe Text) Source #

The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

dbProxyTarget_type :: Lens' DBProxyTarget (Maybe TargetType) Source #

Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

DBProxyTargetGroup

data DBProxyTargetGroup Source #

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.

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

See: newDBProxyTargetGroup smart constructor.

Constructors

DBProxyTargetGroup' 

Fields

  • connectionPoolConfig :: Maybe ConnectionPoolConfigurationInfo

    The settings that determine the size and behavior of the connection pool for the target group.

  • createdDate :: Maybe ISO8601

    The date and time when the target group was first created.

  • dbProxyName :: Maybe Text

    The identifier for the RDS proxy associated with this target group.

  • isDefault :: Maybe Bool

    Whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.

  • status :: Maybe Text

    The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.

  • targetGroupArn :: Maybe Text

    The Amazon Resource Name (ARN) representing the target group.

  • targetGroupName :: Maybe Text

    The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

  • updatedDate :: Maybe ISO8601

    The date and time when the target group was last updated.

Instances

Instances details
FromXML DBProxyTargetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTargetGroup

Generic DBProxyTargetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTargetGroup

Associated Types

type Rep DBProxyTargetGroup :: Type -> Type #

Read DBProxyTargetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTargetGroup

Show DBProxyTargetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTargetGroup

NFData DBProxyTargetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTargetGroup

Methods

rnf :: DBProxyTargetGroup -> () #

Eq DBProxyTargetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTargetGroup

Hashable DBProxyTargetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTargetGroup

type Rep DBProxyTargetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBProxyTargetGroup

newDBProxyTargetGroup :: DBProxyTargetGroup Source #

Create a value of DBProxyTargetGroup with all optional fields omitted.

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

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

$sel:connectionPoolConfig:DBProxyTargetGroup', dbProxyTargetGroup_connectionPoolConfig - The settings that determine the size and behavior of the connection pool for the target group.

$sel:createdDate:DBProxyTargetGroup', dbProxyTargetGroup_createdDate - The date and time when the target group was first created.

$sel:dbProxyName:DBProxyTargetGroup', dbProxyTargetGroup_dbProxyName - The identifier for the RDS proxy associated with this target group.

$sel:isDefault:DBProxyTargetGroup', dbProxyTargetGroup_isDefault - Whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.

$sel:status:DBProxyTargetGroup', dbProxyTargetGroup_status - The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.

$sel:targetGroupArn:DBProxyTargetGroup', dbProxyTargetGroup_targetGroupArn - The Amazon Resource Name (ARN) representing the target group.

$sel:targetGroupName:DBProxyTargetGroup', dbProxyTargetGroup_targetGroupName - The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

$sel:updatedDate:DBProxyTargetGroup', dbProxyTargetGroup_updatedDate - The date and time when the target group was last updated.

dbProxyTargetGroup_connectionPoolConfig :: Lens' DBProxyTargetGroup (Maybe ConnectionPoolConfigurationInfo) Source #

The settings that determine the size and behavior of the connection pool for the target group.

dbProxyTargetGroup_createdDate :: Lens' DBProxyTargetGroup (Maybe UTCTime) Source #

The date and time when the target group was first created.

dbProxyTargetGroup_dbProxyName :: Lens' DBProxyTargetGroup (Maybe Text) Source #

The identifier for the RDS proxy associated with this target group.

dbProxyTargetGroup_isDefault :: Lens' DBProxyTargetGroup (Maybe Bool) Source #

Whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.

dbProxyTargetGroup_status :: Lens' DBProxyTargetGroup (Maybe Text) Source #

The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.

dbProxyTargetGroup_targetGroupArn :: Lens' DBProxyTargetGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) representing the target group.

dbProxyTargetGroup_targetGroupName :: Lens' DBProxyTargetGroup (Maybe Text) Source #

The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

dbProxyTargetGroup_updatedDate :: Lens' DBProxyTargetGroup (Maybe UTCTime) Source #

The date and time when the target group was last updated.

DBSecurityGroup

data DBSecurityGroup Source #

Contains the details for an Amazon RDS DB security group.

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

See: newDBSecurityGroup smart constructor.

Constructors

DBSecurityGroup' 

Fields

Instances

Instances details
FromXML DBSecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroup

Generic DBSecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroup

Associated Types

type Rep DBSecurityGroup :: Type -> Type #

Read DBSecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroup

Show DBSecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroup

NFData DBSecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroup

Methods

rnf :: DBSecurityGroup -> () #

Eq DBSecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroup

Hashable DBSecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroup

type Rep DBSecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroup

type Rep DBSecurityGroup = D1 ('MetaData "DBSecurityGroup" "Amazonka.RDS.Types.DBSecurityGroup" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBSecurityGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbSecurityGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dbSecurityGroupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbSecurityGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "eC2SecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EC2SecurityGroup])) :*: S1 ('MetaSel ('Just "iPRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IPRange]))) :*: (S1 ('MetaSel ('Just "ownerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDBSecurityGroup :: DBSecurityGroup Source #

Create a value of DBSecurityGroup with all optional fields omitted.

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

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

$sel:dbSecurityGroupArn:DBSecurityGroup', dbSecurityGroup_dbSecurityGroupArn - The Amazon Resource Name (ARN) for the DB security group.

$sel:dbSecurityGroupDescription:DBSecurityGroup', dbSecurityGroup_dbSecurityGroupDescription - Provides the description of the DB security group.

$sel:dbSecurityGroupName:DBSecurityGroup', dbSecurityGroup_dbSecurityGroupName - Specifies the name of the DB security group.

$sel:eC2SecurityGroups:DBSecurityGroup', dbSecurityGroup_eC2SecurityGroups - Contains a list of EC2SecurityGroup elements.

$sel:iPRanges:DBSecurityGroup', dbSecurityGroup_iPRanges - Contains a list of IPRange elements.

$sel:ownerId:DBSecurityGroup', dbSecurityGroup_ownerId - Provides the Amazon Web Services ID of the owner of a specific DB security group.

$sel:vpcId:DBSecurityGroup', dbSecurityGroup_vpcId - Provides the VpcId of the DB security group.

dbSecurityGroup_dbSecurityGroupArn :: Lens' DBSecurityGroup (Maybe Text) Source #

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

dbSecurityGroup_dbSecurityGroupDescription :: Lens' DBSecurityGroup (Maybe Text) Source #

Provides the description of the DB security group.

dbSecurityGroup_dbSecurityGroupName :: Lens' DBSecurityGroup (Maybe Text) Source #

Specifies the name of the DB security group.

dbSecurityGroup_eC2SecurityGroups :: Lens' DBSecurityGroup (Maybe [EC2SecurityGroup]) Source #

Contains a list of EC2SecurityGroup elements.

dbSecurityGroup_iPRanges :: Lens' DBSecurityGroup (Maybe [IPRange]) Source #

Contains a list of IPRange elements.

dbSecurityGroup_ownerId :: Lens' DBSecurityGroup (Maybe Text) Source #

Provides the Amazon Web Services ID of the owner of a specific DB security group.

dbSecurityGroup_vpcId :: Lens' DBSecurityGroup (Maybe Text) Source #

Provides the VpcId 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: newDBSecurityGroupMembership smart constructor.

Constructors

DBSecurityGroupMembership' 

Fields

Instances

Instances details
FromXML DBSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroupMembership

Generic DBSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroupMembership

Associated Types

type Rep DBSecurityGroupMembership :: Type -> Type #

Read DBSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroupMembership

Show DBSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroupMembership

NFData DBSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroupMembership

Eq DBSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroupMembership

Hashable DBSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroupMembership

type Rep DBSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSecurityGroupMembership

type Rep DBSecurityGroupMembership = D1 ('MetaData "DBSecurityGroupMembership" "Amazonka.RDS.Types.DBSecurityGroupMembership" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBSecurityGroupMembership'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSecurityGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDBSecurityGroupMembership :: DBSecurityGroupMembership Source #

Create a value of DBSecurityGroupMembership with all optional fields omitted.

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

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

$sel:dbSecurityGroupName:DBSecurityGroupMembership', dbSecurityGroupMembership_dbSecurityGroupName - The name of the DB security group.

$sel:status:DBSecurityGroupMembership', dbSecurityGroupMembership_status - The status of the DB security group.

DBSnapshot

data DBSnapshot Source #

Contains the details of an Amazon RDS DB snapshot.

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

See: newDBSnapshot smart constructor.

Constructors

DBSnapshot' 

Fields

  • allocatedStorage :: Maybe Int

    Specifies the allocated storage size in gibibytes (GiB).

  • availabilityZone :: Maybe Text

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

  • dbInstanceIdentifier :: Maybe Text

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

  • dbSnapshotArn :: Maybe Text

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

  • dbSnapshotIdentifier :: Maybe Text

    Specifies the identifier for the DB snapshot.

  • dbiResourceId :: Maybe Text

    The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

  • encrypted :: Maybe Bool

    Specifies whether the DB snapshot is encrypted.

  • engine :: Maybe Text

    Specifies the name of the database engine.

  • engineVersion :: Maybe Text

    Specifies the version of the database engine.

  • iAMDatabaseAuthenticationEnabled :: Maybe Bool

    True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

  • instanceCreateTime :: Maybe ISO8601

    Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

  • iops :: Maybe Int

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

  • kmsKeyId :: Maybe Text

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

    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

  • licenseModel :: Maybe Text

    License model information for the restored DB instance.

  • masterUsername :: Maybe Text

    Provides the master username for the DB snapshot.

  • optionGroupName :: Maybe Text

    Provides the option group name for the DB snapshot.

  • originalSnapshotCreateTime :: Maybe ISO8601

    Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

  • percentProgress :: Maybe Int

    The percentage of the estimated data that has been transferred.

  • port :: Maybe Int

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

  • processorFeatures :: Maybe [ProcessorFeature]

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

  • snapshotCreateTime :: Maybe ISO8601

    Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

  • snapshotDatabaseTime :: Maybe ISO8601

    The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

    If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

  • snapshotTarget :: Maybe Text

    Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

  • snapshotType :: Maybe Text

    Provides the type of the DB snapshot.

  • sourceDBSnapshotIdentifier :: Maybe Text

    The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

  • sourceRegion :: Maybe Text

    The Amazon Web Services Region that the DB snapshot was created in or copied from.

  • status :: Maybe Text

    Specifies the status of this DB snapshot.

  • storageThroughput :: Maybe Int

    Specifies the storage throughput for the DB snapshot.

  • storageType :: Maybe Text

    Specifies the storage type associated with DB snapshot.

  • tagList :: Maybe [Tag]
     
  • tdeCredentialArn :: Maybe Text

    The ARN from the key store with which to associate the instance for TDE encryption.

  • timezone :: Maybe Text

    The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

  • vpcId :: Maybe Text

    Provides the VPC ID associated with the DB snapshot.

Instances

Instances details
FromXML DBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshot

Generic DBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshot

Associated Types

type Rep DBSnapshot :: Type -> Type #

Read DBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshot

Show DBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshot

NFData DBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshot

Methods

rnf :: DBSnapshot -> () #

Eq DBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshot

Hashable DBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshot

type Rep DBSnapshot Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshot

type Rep DBSnapshot = D1 ('MetaData "DBSnapshot" "Amazonka.RDS.Types.DBSnapshot" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBSnapshot'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbSnapshotArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "dbSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbiResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "encrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iAMDatabaseAuthenticationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "instanceCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: ((((S1 ('MetaSel ('Just "originalSnapshotCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "percentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "processorFeatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProcessorFeature])))) :*: ((S1 ('MetaSel ('Just "snapshotCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "snapshotDatabaseTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "snapshotTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "snapshotType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "sourceDBSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "storageThroughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "tdeCredentialArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))))

newDBSnapshot :: DBSnapshot Source #

Create a value of DBSnapshot with all optional fields omitted.

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

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

$sel:allocatedStorage:DBSnapshot', dbSnapshot_allocatedStorage - Specifies the allocated storage size in gibibytes (GiB).

$sel:availabilityZone:DBSnapshot', dbSnapshot_availabilityZone - Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

$sel:dbInstanceIdentifier:DBSnapshot', dbSnapshot_dbInstanceIdentifier - Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

$sel:dbSnapshotArn:DBSnapshot', dbSnapshot_dbSnapshotArn - The Amazon Resource Name (ARN) for the DB snapshot.

$sel:dbSnapshotIdentifier:DBSnapshot', dbSnapshot_dbSnapshotIdentifier - Specifies the identifier for the DB snapshot.

$sel:dbiResourceId:DBSnapshot', dbSnapshot_dbiResourceId - The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

$sel:encrypted:DBSnapshot', dbSnapshot_encrypted - Specifies whether the DB snapshot is encrypted.

$sel:engine:DBSnapshot', dbSnapshot_engine - Specifies the name of the database engine.

$sel:engineVersion:DBSnapshot', dbSnapshot_engineVersion - Specifies the version of the database engine.

$sel:iAMDatabaseAuthenticationEnabled:DBSnapshot', dbSnapshot_iAMDatabaseAuthenticationEnabled - True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

$sel:instanceCreateTime:DBSnapshot', dbSnapshot_instanceCreateTime - Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

$sel:iops:DBSnapshot', dbSnapshot_iops - Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

$sel:kmsKeyId:DBSnapshot', dbSnapshot_kmsKeyId - If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

$sel:licenseModel:DBSnapshot', dbSnapshot_licenseModel - License model information for the restored DB instance.

$sel:masterUsername:DBSnapshot', dbSnapshot_masterUsername - Provides the master username for the DB snapshot.

$sel:optionGroupName:DBSnapshot', dbSnapshot_optionGroupName - Provides the option group name for the DB snapshot.

$sel:originalSnapshotCreateTime:DBSnapshot', dbSnapshot_originalSnapshotCreateTime - Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

$sel:percentProgress:DBSnapshot', dbSnapshot_percentProgress - The percentage of the estimated data that has been transferred.

$sel:port:DBSnapshot', dbSnapshot_port - Specifies the port that the database engine was listening on at the time of the snapshot.

$sel:processorFeatures:DBSnapshot', dbSnapshot_processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

$sel:snapshotCreateTime:DBSnapshot', dbSnapshot_snapshotCreateTime - Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

$sel:snapshotDatabaseTime:DBSnapshot', dbSnapshot_snapshotDatabaseTime - The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

$sel:snapshotTarget:DBSnapshot', dbSnapshot_snapshotTarget - Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

$sel:snapshotType:DBSnapshot', dbSnapshot_snapshotType - Provides the type of the DB snapshot.

$sel:sourceDBSnapshotIdentifier:DBSnapshot', dbSnapshot_sourceDBSnapshotIdentifier - The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

$sel:sourceRegion:DBSnapshot', dbSnapshot_sourceRegion - The Amazon Web Services Region that the DB snapshot was created in or copied from.

$sel:status:DBSnapshot', dbSnapshot_status - Specifies the status of this DB snapshot.

$sel:storageThroughput:DBSnapshot', dbSnapshot_storageThroughput - Specifies the storage throughput for the DB snapshot.

$sel:storageType:DBSnapshot', dbSnapshot_storageType - Specifies the storage type associated with DB snapshot.

$sel:tagList:DBSnapshot', dbSnapshot_tagList - Undocumented member.

$sel:tdeCredentialArn:DBSnapshot', dbSnapshot_tdeCredentialArn - The ARN from the key store with which to associate the instance for TDE encryption.

$sel:timezone:DBSnapshot', dbSnapshot_timezone - The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

$sel:vpcId:DBSnapshot', dbSnapshot_vpcId - Provides the VPC ID associated with the DB snapshot.

dbSnapshot_allocatedStorage :: Lens' DBSnapshot (Maybe Int) Source #

Specifies the allocated storage size in gibibytes (GiB).

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

dbSnapshot_dbInstanceIdentifier :: Lens' DBSnapshot (Maybe Text) Source #

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

dbSnapshot_dbSnapshotArn :: Lens' DBSnapshot (Maybe Text) Source #

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

dbSnapshot_dbSnapshotIdentifier :: Lens' DBSnapshot (Maybe Text) Source #

Specifies the identifier for the DB snapshot.

dbSnapshot_dbiResourceId :: Lens' DBSnapshot (Maybe Text) Source #

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

dbSnapshot_encrypted :: Lens' DBSnapshot (Maybe Bool) Source #

Specifies whether the DB snapshot is encrypted.

dbSnapshot_engine :: Lens' DBSnapshot (Maybe Text) Source #

Specifies the name of the database engine.

dbSnapshot_engineVersion :: Lens' DBSnapshot (Maybe Text) Source #

Specifies the version of the database engine.

dbSnapshot_iAMDatabaseAuthenticationEnabled :: Lens' DBSnapshot (Maybe Bool) Source #

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

dbSnapshot_instanceCreateTime :: Lens' DBSnapshot (Maybe UTCTime) Source #

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

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

dbSnapshot_kmsKeyId :: Lens' DBSnapshot (Maybe Text) Source #

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

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

dbSnapshot_licenseModel :: Lens' DBSnapshot (Maybe Text) Source #

License model information for the restored DB instance.

dbSnapshot_masterUsername :: Lens' DBSnapshot (Maybe Text) Source #

Provides the master username for the DB snapshot.

dbSnapshot_optionGroupName :: Lens' DBSnapshot (Maybe Text) Source #

Provides the option group name for the DB snapshot.

dbSnapshot_originalSnapshotCreateTime :: Lens' DBSnapshot (Maybe UTCTime) Source #

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

dbSnapshot_percentProgress :: Lens' DBSnapshot (Maybe Int) Source #

The percentage of the estimated data that has been transferred.

dbSnapshot_port :: Lens' DBSnapshot (Maybe Int) Source #

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

dbSnapshot_processorFeatures :: Lens' DBSnapshot (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

dbSnapshot_snapshotCreateTime :: Lens' DBSnapshot (Maybe UTCTime) Source #

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

dbSnapshot_snapshotDatabaseTime :: Lens' DBSnapshot (Maybe UTCTime) Source #

The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

dbSnapshot_snapshotTarget :: Lens' DBSnapshot (Maybe Text) Source #

Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

dbSnapshot_snapshotType :: Lens' DBSnapshot (Maybe Text) Source #

Provides the type of the DB snapshot.

dbSnapshot_sourceDBSnapshotIdentifier :: Lens' DBSnapshot (Maybe Text) Source #

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

dbSnapshot_sourceRegion :: Lens' DBSnapshot (Maybe Text) Source #

The Amazon Web Services Region that the DB snapshot was created in or copied from.

dbSnapshot_status :: Lens' DBSnapshot (Maybe Text) Source #

Specifies the status of this DB snapshot.

dbSnapshot_storageThroughput :: Lens' DBSnapshot (Maybe Int) Source #

Specifies the storage throughput for the DB snapshot.

dbSnapshot_storageType :: Lens' DBSnapshot (Maybe Text) Source #

Specifies the storage type associated with DB snapshot.

dbSnapshot_tagList :: Lens' DBSnapshot (Maybe [Tag]) Source #

Undocumented member.

dbSnapshot_tdeCredentialArn :: Lens' DBSnapshot (Maybe Text) Source #

The ARN from the key store with which to associate the instance for TDE encryption.

dbSnapshot_timezone :: Lens' DBSnapshot (Maybe Text) Source #

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

dbSnapshot_vpcId :: Lens' DBSnapshot (Maybe Text) Source #

Provides the VPC ID associated with the DB snapshot.

DBSnapshotAttribute

data DBSnapshotAttribute Source #

Contains the name and values of a manual DB snapshot attribute

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.

See: newDBSnapshotAttribute smart constructor.

Constructors

DBSnapshotAttribute' 

Fields

  • attributeName :: Maybe Text

    The name of the manual DB snapshot attribute.

    The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

  • attributeValues :: Maybe [Text]

    The value or values for the manual DB snapshot attribute.

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

Instances

Instances details
FromXML DBSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttribute

Generic DBSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttribute

Associated Types

type Rep DBSnapshotAttribute :: Type -> Type #

Read DBSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttribute

Show DBSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttribute

NFData DBSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttribute

Methods

rnf :: DBSnapshotAttribute -> () #

Eq DBSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttribute

Hashable DBSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttribute

type Rep DBSnapshotAttribute Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttribute

type Rep DBSnapshotAttribute = D1 ('MetaData "DBSnapshotAttribute" "Amazonka.RDS.Types.DBSnapshotAttribute" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBSnapshotAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "attributeValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newDBSnapshotAttribute :: DBSnapshotAttribute Source #

Create a value of DBSnapshotAttribute with all optional fields omitted.

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

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

$sel:attributeName:DBSnapshotAttribute', dbSnapshotAttribute_attributeName - The name of the manual DB snapshot attribute.

The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

$sel:attributeValues:DBSnapshotAttribute', dbSnapshotAttribute_attributeValues - The value or values for the manual DB snapshot attribute.

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

dbSnapshotAttribute_attributeName :: Lens' DBSnapshotAttribute (Maybe Text) Source #

The name of the manual DB snapshot attribute.

The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

dbSnapshotAttribute_attributeValues :: Lens' DBSnapshotAttribute (Maybe [Text]) Source #

The value or values for the manual DB snapshot attribute.

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

DBSnapshotAttributesResult

data DBSnapshotAttributesResult Source #

Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

See: newDBSnapshotAttributesResult smart constructor.

Constructors

DBSnapshotAttributesResult' 

Fields

Instances

Instances details
FromXML DBSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttributesResult

Generic DBSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttributesResult

Associated Types

type Rep DBSnapshotAttributesResult :: Type -> Type #

Read DBSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttributesResult

Show DBSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttributesResult

NFData DBSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttributesResult

Eq DBSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttributesResult

Hashable DBSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttributesResult

type Rep DBSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSnapshotAttributesResult

type Rep DBSnapshotAttributesResult = D1 ('MetaData "DBSnapshotAttributesResult" "Amazonka.RDS.Types.DBSnapshotAttributesResult" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBSnapshotAttributesResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSnapshotAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBSnapshotAttribute])) :*: S1 ('MetaSel ('Just "dbSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDBSnapshotAttributesResult :: DBSnapshotAttributesResult Source #

Create a value of DBSnapshotAttributesResult with all optional fields omitted.

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

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

$sel:dbSnapshotAttributes:DBSnapshotAttributesResult', dbSnapshotAttributesResult_dbSnapshotAttributes - The list of attributes and values for the manual DB snapshot.

$sel:dbSnapshotIdentifier:DBSnapshotAttributesResult', dbSnapshotAttributesResult_dbSnapshotIdentifier - The identifier of the manual DB snapshot that the attributes apply to.

dbSnapshotAttributesResult_dbSnapshotAttributes :: Lens' DBSnapshotAttributesResult (Maybe [DBSnapshotAttribute]) Source #

The list of attributes and values for the manual DB snapshot.

dbSnapshotAttributesResult_dbSnapshotIdentifier :: Lens' DBSnapshotAttributesResult (Maybe Text) Source #

The identifier of the manual DB snapshot that the attributes apply to.

DBSubnetGroup

data DBSubnetGroup Source #

Contains the details of an Amazon RDS DB subnet group.

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

See: newDBSubnetGroup smart constructor.

Constructors

DBSubnetGroup' 

Fields

Instances

Instances details
FromXML DBSubnetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSubnetGroup

Generic DBSubnetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSubnetGroup

Associated Types

type Rep DBSubnetGroup :: Type -> Type #

Read DBSubnetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSubnetGroup

Show DBSubnetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSubnetGroup

NFData DBSubnetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSubnetGroup

Methods

rnf :: DBSubnetGroup -> () #

Eq DBSubnetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSubnetGroup

Hashable DBSubnetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSubnetGroup

type Rep DBSubnetGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBSubnetGroup

type Rep DBSubnetGroup = D1 ('MetaData "DBSubnetGroup" "Amazonka.RDS.Types.DBSubnetGroup" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBSubnetGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbSubnetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dbSubnetGroupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "subnetGroupStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Subnet]))) :*: (S1 ('MetaSel ('Just "supportedNetworkTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDBSubnetGroup :: DBSubnetGroup Source #

Create a value of DBSubnetGroup with all optional fields omitted.

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

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

$sel:dbSubnetGroupArn:DBSubnetGroup', dbSubnetGroup_dbSubnetGroupArn - The Amazon Resource Name (ARN) for the DB subnet group.

$sel:dbSubnetGroupDescription:DBSubnetGroup', dbSubnetGroup_dbSubnetGroupDescription - Provides the description of the DB subnet group.

$sel:dbSubnetGroupName:DBSubnetGroup', dbSubnetGroup_dbSubnetGroupName - The name of the DB subnet group.

$sel:subnetGroupStatus:DBSubnetGroup', dbSubnetGroup_subnetGroupStatus - Provides the status of the DB subnet group.

$sel:subnets:DBSubnetGroup', dbSubnetGroup_subnets - Contains a list of Subnet elements.

$sel:supportedNetworkTypes:DBSubnetGroup', dbSubnetGroup_supportedNetworkTypes - The network type of the DB subnet group.

Valid values:

  • IPV4
  • DUAL

A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

$sel:vpcId:DBSubnetGroup', dbSubnetGroup_vpcId - Provides the VpcId of the DB subnet group.

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

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

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

Provides the description of the DB subnet group.

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

Provides the status of the DB subnet group.

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

Contains a list of Subnet elements.

dbSubnetGroup_supportedNetworkTypes :: Lens' DBSubnetGroup (Maybe [Text]) Source #

The network type of the DB subnet group.

Valid values:

  • IPV4
  • DUAL

A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

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

Provides the VpcId of the DB subnet group.

DescribeDBLogFilesDetails

data DescribeDBLogFilesDetails Source #

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

See: newDescribeDBLogFilesDetails smart constructor.

Constructors

DescribeDBLogFilesDetails' 

Fields

Instances

Instances details
FromXML DescribeDBLogFilesDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.DescribeDBLogFilesDetails

Generic DescribeDBLogFilesDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.DescribeDBLogFilesDetails

Associated Types

type Rep DescribeDBLogFilesDetails :: Type -> Type #

Read DescribeDBLogFilesDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.DescribeDBLogFilesDetails

Show DescribeDBLogFilesDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.DescribeDBLogFilesDetails

NFData DescribeDBLogFilesDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.DescribeDBLogFilesDetails

Eq DescribeDBLogFilesDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.DescribeDBLogFilesDetails

Hashable DescribeDBLogFilesDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.DescribeDBLogFilesDetails

type Rep DescribeDBLogFilesDetails Source # 
Instance details

Defined in Amazonka.RDS.Types.DescribeDBLogFilesDetails

type Rep DescribeDBLogFilesDetails = D1 ('MetaData "DescribeDBLogFilesDetails" "Amazonka.RDS.Types.DescribeDBLogFilesDetails" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBLogFilesDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lastWritten") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "logFileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))

newDescribeDBLogFilesDetails :: DescribeDBLogFilesDetails Source #

Create a value of DescribeDBLogFilesDetails with all optional fields omitted.

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

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

$sel:lastWritten:DescribeDBLogFilesDetails', describeDBLogFilesDetails_lastWritten - A POSIX timestamp when the last log entry was written.

$sel:logFileName:DescribeDBLogFilesDetails', describeDBLogFilesDetails_logFileName - The name of the log file for the specified DB instance.

$sel:size:DescribeDBLogFilesDetails', describeDBLogFilesDetails_size - The size, in bytes, of the log file for the specified DB instance.

describeDBLogFilesDetails_lastWritten :: Lens' DescribeDBLogFilesDetails (Maybe Integer) Source #

A POSIX timestamp when the last log entry was written.

describeDBLogFilesDetails_logFileName :: Lens' DescribeDBLogFilesDetails (Maybe Text) Source #

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

describeDBLogFilesDetails_size :: Lens' DescribeDBLogFilesDetails (Maybe Integer) Source #

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

DomainMembership

data DomainMembership Source #

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

See: newDomainMembership smart constructor.

Constructors

DomainMembership' 

Fields

  • domain :: Maybe Text

    The identifier of the Active Directory Domain.

  • fqdn :: Maybe Text

    The fully qualified domain name of the Active Directory Domain.

  • iAMRoleName :: Maybe Text

    The name of the IAM role to be used when making API calls to the Directory Service.

  • status :: Maybe Text

    The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

Instances

Instances details
FromXML DomainMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DomainMembership

Generic DomainMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DomainMembership

Associated Types

type Rep DomainMembership :: Type -> Type #

Read DomainMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DomainMembership

Show DomainMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DomainMembership

NFData DomainMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DomainMembership

Methods

rnf :: DomainMembership -> () #

Eq DomainMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DomainMembership

Hashable DomainMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DomainMembership

type Rep DomainMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.DomainMembership

type Rep DomainMembership = D1 ('MetaData "DomainMembership" "Amazonka.RDS.Types.DomainMembership" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DomainMembership'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fqdn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "iAMRoleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDomainMembership :: DomainMembership Source #

Create a value of DomainMembership with all optional fields omitted.

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

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

$sel:domain:DomainMembership', domainMembership_domain - The identifier of the Active Directory Domain.

$sel:fqdn:DomainMembership', domainMembership_fqdn - The fully qualified domain name of the Active Directory Domain.

$sel:iAMRoleName:DomainMembership', domainMembership_iAMRoleName - The name of the IAM role to be used when making API calls to the Directory Service.

$sel:status:DomainMembership', domainMembership_status - The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

domainMembership_domain :: Lens' DomainMembership (Maybe Text) Source #

The identifier of the Active Directory Domain.

domainMembership_fqdn :: Lens' DomainMembership (Maybe Text) Source #

The fully qualified domain name of the Active Directory Domain.

domainMembership_iAMRoleName :: Lens' DomainMembership (Maybe Text) Source #

The name of the IAM role to be used when making API calls to the Directory Service.

domainMembership_status :: Lens' DomainMembership (Maybe Text) Source #

The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

DoubleRange

data DoubleRange Source #

A range of double values.

See: newDoubleRange smart constructor.

Constructors

DoubleRange' 

Fields

Instances

Instances details
FromXML DoubleRange Source # 
Instance details

Defined in Amazonka.RDS.Types.DoubleRange

Generic DoubleRange Source # 
Instance details

Defined in Amazonka.RDS.Types.DoubleRange

Associated Types

type Rep DoubleRange :: Type -> Type #

Read DoubleRange Source # 
Instance details

Defined in Amazonka.RDS.Types.DoubleRange

Show DoubleRange Source # 
Instance details

Defined in Amazonka.RDS.Types.DoubleRange

NFData DoubleRange Source # 
Instance details

Defined in Amazonka.RDS.Types.DoubleRange

Methods

rnf :: DoubleRange -> () #

Eq DoubleRange Source # 
Instance details

Defined in Amazonka.RDS.Types.DoubleRange

Hashable DoubleRange Source # 
Instance details

Defined in Amazonka.RDS.Types.DoubleRange

type Rep DoubleRange Source # 
Instance details

Defined in Amazonka.RDS.Types.DoubleRange

type Rep DoubleRange = D1 ('MetaData "DoubleRange" "Amazonka.RDS.Types.DoubleRange" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DoubleRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "from") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "to") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newDoubleRange :: DoubleRange Source #

Create a value of DoubleRange with all optional fields omitted.

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

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

$sel:from:DoubleRange', doubleRange_from - The minimum value in the range.

$sel:to:DoubleRange', doubleRange_to - The maximum value in the range.

doubleRange_from :: Lens' DoubleRange (Maybe Double) Source #

The minimum value in the range.

doubleRange_to :: Lens' DoubleRange (Maybe Double) Source #

The maximum value in the range.

EC2SecurityGroup

data EC2SecurityGroup Source #

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

  • AuthorizeDBSecurityGroupIngress
  • DescribeDBSecurityGroups
  • RevokeDBSecurityGroupIngress

See: newEC2SecurityGroup smart constructor.

Constructors

EC2SecurityGroup' 

Fields

Instances

Instances details
FromXML EC2SecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.EC2SecurityGroup

Generic EC2SecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.EC2SecurityGroup

Associated Types

type Rep EC2SecurityGroup :: Type -> Type #

Read EC2SecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.EC2SecurityGroup

Show EC2SecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.EC2SecurityGroup

NFData EC2SecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.EC2SecurityGroup

Methods

rnf :: EC2SecurityGroup -> () #

Eq EC2SecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.EC2SecurityGroup

Hashable EC2SecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.EC2SecurityGroup

type Rep EC2SecurityGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.EC2SecurityGroup

type Rep EC2SecurityGroup = D1 ('MetaData "EC2SecurityGroup" "Amazonka.RDS.Types.EC2SecurityGroup" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "EC2SecurityGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eC2SecurityGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eC2SecurityGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "eC2SecurityGroupOwnerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newEC2SecurityGroup :: EC2SecurityGroup Source #

Create a value of EC2SecurityGroup with all optional fields omitted.

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

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

$sel:eC2SecurityGroupId:EC2SecurityGroup', eC2SecurityGroup_eC2SecurityGroupId - Specifies the id of the EC2 security group.

$sel:eC2SecurityGroupName:EC2SecurityGroup', eC2SecurityGroup_eC2SecurityGroupName - Specifies the name of the EC2 security group.

$sel:eC2SecurityGroupOwnerId:EC2SecurityGroup', eC2SecurityGroup_eC2SecurityGroupOwnerId - Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

$sel:status:EC2SecurityGroup', eC2SecurityGroup_status - Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

eC2SecurityGroup_eC2SecurityGroupId :: Lens' EC2SecurityGroup (Maybe Text) Source #

Specifies the id of the EC2 security group.

eC2SecurityGroup_eC2SecurityGroupName :: Lens' EC2SecurityGroup (Maybe Text) Source #

Specifies the name of the EC2 security group.

eC2SecurityGroup_eC2SecurityGroupOwnerId :: Lens' EC2SecurityGroup (Maybe Text) Source #

Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

eC2SecurityGroup_status :: Lens' EC2SecurityGroup (Maybe Text) Source #

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

Endpoint

data Endpoint Source #

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

  • CreateDBInstance
  • DescribeDBInstances
  • DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

See: newEndpoint smart constructor.

Constructors

Endpoint' 

Fields

  • address :: Maybe Text

    Specifies the DNS address of the DB instance.

  • hostedZoneId :: Maybe Text

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

  • port :: Maybe Int

    Specifies the port that the database engine is listening on.

Instances

Instances details
FromXML Endpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.Endpoint

Generic Endpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.Endpoint

Associated Types

type Rep Endpoint :: Type -> Type #

Methods

from :: Endpoint -> Rep Endpoint x #

to :: Rep Endpoint x -> Endpoint #

Read Endpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.Endpoint

Show Endpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.Endpoint

NFData Endpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.Endpoint

Methods

rnf :: Endpoint -> () #

Eq Endpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.Endpoint

Hashable Endpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.Endpoint

Methods

hashWithSalt :: Int -> Endpoint -> Int #

hash :: Endpoint -> Int #

type Rep Endpoint Source # 
Instance details

Defined in Amazonka.RDS.Types.Endpoint

type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.RDS.Types.Endpoint" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newEndpoint :: Endpoint Source #

Create a value of Endpoint with all optional fields omitted.

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

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

$sel:address:Endpoint', endpoint_address - Specifies the DNS address of the DB instance.

$sel:hostedZoneId:Endpoint', endpoint_hostedZoneId - Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

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

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

Specifies the DNS address of the DB instance.

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

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

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

Specifies the port that the database engine is listening on.

EngineDefaults

data EngineDefaults Source #

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

See: newEngineDefaults smart constructor.

Constructors

EngineDefaults' 

Fields

  • dbParameterGroupFamily :: Maybe Text

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

  • marker :: Maybe Text

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

  • parameters :: Maybe [Parameter]

    Contains a list of engine default parameters.

Instances

Instances details
FromXML EngineDefaults Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineDefaults

Generic EngineDefaults Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineDefaults

Associated Types

type Rep EngineDefaults :: Type -> Type #

Read EngineDefaults Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineDefaults

Show EngineDefaults Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineDefaults

NFData EngineDefaults Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineDefaults

Methods

rnf :: EngineDefaults -> () #

Eq EngineDefaults Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineDefaults

Hashable EngineDefaults Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineDefaults

type Rep EngineDefaults Source # 
Instance details

Defined in Amazonka.RDS.Types.EngineDefaults

type Rep EngineDefaults = D1 ('MetaData "EngineDefaults" "Amazonka.RDS.Types.EngineDefaults" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "EngineDefaults'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])))))

newEngineDefaults :: EngineDefaults Source #

Create a value of EngineDefaults with all optional fields omitted.

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

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

$sel:dbParameterGroupFamily:EngineDefaults', engineDefaults_dbParameterGroupFamily - Specifies the name of the DB parameter group family that the engine default parameters apply to.

$sel:marker:EngineDefaults', engineDefaults_marker - 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 .

$sel:parameters:EngineDefaults', engineDefaults_parameters - Contains a list of engine default parameters.

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

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

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

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

Contains a list of engine default parameters.

Event

data Event Source #

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

See: newEvent smart constructor.

Constructors

Event' 

Fields

Instances

Instances details
FromXML Event Source # 
Instance details

Defined in Amazonka.RDS.Types.Event

Methods

parseXML :: [Node] -> Either String Event #

Generic Event Source # 
Instance details

Defined in Amazonka.RDS.Types.Event

Associated Types

type Rep Event :: Type -> Type #

Methods

from :: Event -> Rep Event x #

to :: Rep Event x -> Event #

Read Event Source # 
Instance details

Defined in Amazonka.RDS.Types.Event

Show Event Source # 
Instance details

Defined in Amazonka.RDS.Types.Event

Methods

showsPrec :: Int -> Event -> ShowS #

show :: Event -> String #

showList :: [Event] -> ShowS #

NFData Event Source # 
Instance details

Defined in Amazonka.RDS.Types.Event

Methods

rnf :: Event -> () #

Eq Event Source # 
Instance details

Defined in Amazonka.RDS.Types.Event

Methods

(==) :: Event -> Event -> Bool #

(/=) :: Event -> Event -> Bool #

Hashable Event Source # 
Instance details

Defined in Amazonka.RDS.Types.Event

Methods

hashWithSalt :: Int -> Event -> Int #

hash :: Event -> Int #

type Rep Event Source # 
Instance details

Defined in Amazonka.RDS.Types.Event

newEvent :: Event Source #

Create a value of Event with all optional fields omitted.

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

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

$sel:date:Event', event_date - Specifies the date and time of the event.

$sel:eventCategories:Event', event_eventCategories - Specifies the category for the event.

$sel:message:Event', event_message - Provides the text of this event.

$sel:sourceArn:Event', event_sourceArn - The Amazon Resource Name (ARN) for the event.

$sel:sourceIdentifier:Event', event_sourceIdentifier - Provides the identifier for the source of the event.

$sel:sourceType:Event', event_sourceType - Specifies the source type for this event.

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

Specifies the date and time of the event.

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

Specifies the category for the event.

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

Provides the text of this event.

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

The Amazon Resource Name (ARN) for the event.

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

Provides the identifier for the source of the event.

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

Specifies the source type for this event.

EventCategoriesMap

data EventCategoriesMap Source #

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

See: newEventCategoriesMap smart constructor.

Constructors

EventCategoriesMap' 

Fields

Instances

Instances details
FromXML EventCategoriesMap Source # 
Instance details

Defined in Amazonka.RDS.Types.EventCategoriesMap

Generic EventCategoriesMap Source # 
Instance details

Defined in Amazonka.RDS.Types.EventCategoriesMap

Associated Types

type Rep EventCategoriesMap :: Type -> Type #

Read EventCategoriesMap Source # 
Instance details

Defined in Amazonka.RDS.Types.EventCategoriesMap

Show EventCategoriesMap Source # 
Instance details

Defined in Amazonka.RDS.Types.EventCategoriesMap

NFData EventCategoriesMap Source # 
Instance details

Defined in Amazonka.RDS.Types.EventCategoriesMap

Methods

rnf :: EventCategoriesMap -> () #

Eq EventCategoriesMap Source # 
Instance details

Defined in Amazonka.RDS.Types.EventCategoriesMap

Hashable EventCategoriesMap Source # 
Instance details

Defined in Amazonka.RDS.Types.EventCategoriesMap

type Rep EventCategoriesMap Source # 
Instance details

Defined in Amazonka.RDS.Types.EventCategoriesMap

type Rep EventCategoriesMap = D1 ('MetaData "EventCategoriesMap" "Amazonka.RDS.Types.EventCategoriesMap" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "EventCategoriesMap'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventCategories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newEventCategoriesMap :: EventCategoriesMap Source #

Create a value of EventCategoriesMap with all optional fields omitted.

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

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

$sel:eventCategories:EventCategoriesMap', eventCategoriesMap_eventCategories - The event categories for the specified source type

$sel:sourceType:EventCategoriesMap', eventCategoriesMap_sourceType - The source type that the returned categories belong to

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

The event categories for the specified source type

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

The source type that the returned categories belong to

EventSubscription

data EventSubscription Source #

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

See: newEventSubscription smart constructor.

Constructors

EventSubscription' 

Fields

  • custSubscriptionId :: Maybe Text

    The RDS event notification subscription Id.

  • customerAwsId :: Maybe Text

    The Amazon Web Services customer account associated with the RDS event notification subscription.

  • enabled :: Maybe Bool

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

  • eventCategoriesList :: Maybe [Text]

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

  • eventSubscriptionArn :: Maybe Text

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

  • snsTopicArn :: Maybe Text

    The topic ARN of the RDS event notification subscription.

  • sourceIdsList :: Maybe [Text]

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

  • sourceType :: Maybe Text

    The source type for the RDS event notification subscription.

  • status :: Maybe Text

    The status of the RDS event notification subscription.

    Constraints:

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

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

  • subscriptionCreationTime :: Maybe Text

    The time the RDS event notification subscription was created.

Instances

Instances details
FromXML EventSubscription Source # 
Instance details

Defined in Amazonka.RDS.Types.EventSubscription

Generic EventSubscription Source # 
Instance details

Defined in Amazonka.RDS.Types.EventSubscription

Associated Types

type Rep EventSubscription :: Type -> Type #

Read EventSubscription Source # 
Instance details

Defined in Amazonka.RDS.Types.EventSubscription

Show EventSubscription Source # 
Instance details

Defined in Amazonka.RDS.Types.EventSubscription

NFData EventSubscription Source # 
Instance details

Defined in Amazonka.RDS.Types.EventSubscription

Methods

rnf :: EventSubscription -> () #

Eq EventSubscription Source # 
Instance details

Defined in Amazonka.RDS.Types.EventSubscription

Hashable EventSubscription Source # 
Instance details

Defined in Amazonka.RDS.Types.EventSubscription

type Rep EventSubscription Source # 
Instance details

Defined in Amazonka.RDS.Types.EventSubscription

type Rep EventSubscription = D1 ('MetaData "EventSubscription" "Amazonka.RDS.Types.EventSubscription" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "EventSubscription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "custSubscriptionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customerAwsId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "eventCategoriesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "eventSubscriptionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceIdsList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subscriptionCreationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newEventSubscription :: EventSubscription Source #

Create a value of EventSubscription with all optional fields omitted.

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

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

$sel:custSubscriptionId:EventSubscription', eventSubscription_custSubscriptionId - The RDS event notification subscription Id.

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

$sel:enabled:EventSubscription', eventSubscription_enabled - A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

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

$sel:eventSubscriptionArn:EventSubscription', eventSubscription_eventSubscriptionArn - The Amazon Resource Name (ARN) for the event subscription.

$sel:snsTopicArn:EventSubscription', eventSubscription_snsTopicArn - The topic ARN of the RDS event notification subscription.

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

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

$sel:status:EventSubscription', eventSubscription_status - 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.

$sel:subscriptionCreationTime:EventSubscription', eventSubscription_subscriptionCreationTime - The time the RDS event notification subscription was created.

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

The RDS event notification subscription Id.

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

The Amazon Web Services customer account associated with the RDS event notification subscription.

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

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

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

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

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

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

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

The topic ARN of the RDS event notification subscription.

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

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

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

The source type for the RDS event notification subscription.

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

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

The time the RDS event notification subscription was created.

ExportTask

data ExportTask Source #

Contains the details of a snapshot export to Amazon S3.

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

See: newExportTask smart constructor.

Constructors

ExportTask' 

Fields

  • exportOnly :: Maybe [Text]

    The data exported from the snapshot. Valid values are the following:

    • database - Export all the data from a specified database.
    • database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
    • database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
    • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
  • exportTaskIdentifier :: Maybe Text

    A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.

  • failureCause :: Maybe Text

    The reason the export failed, if it failed.

  • iamRoleArn :: Maybe Text

    The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

  • kmsKeyId :: Maybe Text

    The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.

  • percentProgress :: Maybe Int

    The progress of the snapshot export task as a percentage.

  • s3Bucket :: Maybe Text

    The Amazon S3 bucket that the snapshot is exported to.

  • s3Prefix :: Maybe Text

    The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

  • snapshotTime :: Maybe ISO8601

    The time that the snapshot was created.

  • sourceArn :: Maybe Text

    The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

  • sourceType :: Maybe ExportSourceType

    The type of source for the export.

  • status :: Maybe Text

    The progress status of the export task.

  • taskEndTime :: Maybe ISO8601

    The time that the snapshot export task completed.

  • taskStartTime :: Maybe ISO8601

    The time that the snapshot export task started.

  • totalExtractedDataInGB :: Maybe Int

    The total amount of data exported, in gigabytes.

  • warningMessage :: Maybe Text

    A warning about the snapshot export task.

Instances

Instances details
FromXML ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

Generic ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

Associated Types

type Rep ExportTask :: Type -> Type #

Read ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

Show ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

NFData ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

Methods

rnf :: ExportTask -> () #

Eq ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

Hashable ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

type Rep ExportTask Source # 
Instance details

Defined in Amazonka.RDS.Types.ExportTask

type Rep ExportTask = D1 ('MetaData "ExportTask" "Amazonka.RDS.Types.ExportTask" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ExportTask'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "exportOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "exportTaskIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "failureCause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "percentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "snapshotTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "sourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportSourceType)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "taskEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "taskStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "totalExtractedDataInGB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "warningMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newExportTask :: ExportTask Source #

Create a value of ExportTask with all optional fields omitted.

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

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

$sel:exportOnly:ExportTask', exportTask_exportOnly - The data exported from the snapshot. Valid values are the following:

  • database - Export all the data from a specified database.
  • database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
  • database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
  • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

$sel:exportTaskIdentifier:ExportTask', exportTask_exportTaskIdentifier - A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.

$sel:failureCause:ExportTask', exportTask_failureCause - The reason the export failed, if it failed.

$sel:iamRoleArn:ExportTask', exportTask_iamRoleArn - The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

$sel:kmsKeyId:ExportTask', exportTask_kmsKeyId - The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.

$sel:percentProgress:ExportTask', exportTask_percentProgress - The progress of the snapshot export task as a percentage.

$sel:s3Bucket:ExportTask', exportTask_s3Bucket - The Amazon S3 bucket that the snapshot is exported to.

$sel:s3Prefix:ExportTask', exportTask_s3Prefix - The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

$sel:snapshotTime:ExportTask', exportTask_snapshotTime - The time that the snapshot was created.

$sel:sourceArn:ExportTask', exportTask_sourceArn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

$sel:sourceType:ExportTask', exportTask_sourceType - The type of source for the export.

$sel:status:ExportTask', exportTask_status - The progress status of the export task.

$sel:taskEndTime:ExportTask', exportTask_taskEndTime - The time that the snapshot export task completed.

$sel:taskStartTime:ExportTask', exportTask_taskStartTime - The time that the snapshot export task started.

$sel:totalExtractedDataInGB:ExportTask', exportTask_totalExtractedDataInGB - The total amount of data exported, in gigabytes.

$sel:warningMessage:ExportTask', exportTask_warningMessage - A warning about the snapshot export task.

exportTask_exportOnly :: Lens' ExportTask (Maybe [Text]) Source #

The data exported from the snapshot. Valid values are the following:

  • database - Export all the data from a specified database.
  • database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
  • database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
  • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

exportTask_exportTaskIdentifier :: Lens' ExportTask (Maybe Text) Source #

A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.

exportTask_failureCause :: Lens' ExportTask (Maybe Text) Source #

The reason the export failed, if it failed.

exportTask_iamRoleArn :: Lens' ExportTask (Maybe Text) Source #

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

exportTask_kmsKeyId :: Lens' ExportTask (Maybe Text) Source #

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.

exportTask_percentProgress :: Lens' ExportTask (Maybe Int) Source #

The progress of the snapshot export task as a percentage.

exportTask_s3Bucket :: Lens' ExportTask (Maybe Text) Source #

The Amazon S3 bucket that the snapshot is exported to.

exportTask_s3Prefix :: Lens' ExportTask (Maybe Text) Source #

The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

exportTask_snapshotTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot was created.

exportTask_sourceArn :: Lens' ExportTask (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

exportTask_sourceType :: Lens' ExportTask (Maybe ExportSourceType) Source #

The type of source for the export.

exportTask_status :: Lens' ExportTask (Maybe Text) Source #

The progress status of the export task.

exportTask_taskEndTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot export task completed.

exportTask_taskStartTime :: Lens' ExportTask (Maybe UTCTime) Source #

The time that the snapshot export task started.

exportTask_totalExtractedDataInGB :: Lens' ExportTask (Maybe Int) Source #

The total amount of data exported, in gigabytes.

exportTask_warningMessage :: Lens' ExportTask (Maybe Text) Source #

A warning about the snapshot export task.

FailoverState

data FailoverState Source #

Contains the state of scheduled or in-process failover operations on an Aurora global database (GlobalCluster). This Data type is empty unless a failover operation is scheduled or is currently underway on the Aurora global database.

See: newFailoverState smart constructor.

Constructors

FailoverState' 

Fields

  • fromDbClusterArn :: Maybe Text

    The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.

  • status :: Maybe FailoverStatus

    The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

    • pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
    • failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
    • cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
  • toDbClusterArn :: Maybe Text

    The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.

Instances

Instances details
FromXML FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

Generic FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

Associated Types

type Rep FailoverState :: Type -> Type #

Read FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

Show FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

NFData FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

Methods

rnf :: FailoverState -> () #

Eq FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

Hashable FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

type Rep FailoverState Source # 
Instance details

Defined in Amazonka.RDS.Types.FailoverState

type Rep FailoverState = D1 ('MetaData "FailoverState" "Amazonka.RDS.Types.FailoverState" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "FailoverState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDbClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailoverStatus)) :*: S1 ('MetaSel ('Just "toDbClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newFailoverState :: FailoverState Source #

Create a value of FailoverState with all optional fields omitted.

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

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

$sel:fromDbClusterArn:FailoverState', failoverState_fromDbClusterArn - The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.

$sel:status:FailoverState', failoverState_status - The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

  • pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
  • failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
  • cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

$sel:toDbClusterArn:FailoverState', failoverState_toDbClusterArn - The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.

failoverState_fromDbClusterArn :: Lens' FailoverState (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.

failoverState_status :: Lens' FailoverState (Maybe FailoverStatus) Source #

The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

  • pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.
  • failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
  • cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

failoverState_toDbClusterArn :: Lens' FailoverState (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.

Filter

data Filter Source #

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Currently, wildcards are not supported in filters.

The following actions can be filtered:

  • DescribeDBClusterBacktracks
  • DescribeDBClusterEndpoints
  • DescribeDBClusters
  • DescribeDBInstances
  • DescribePendingMaintenanceActions

See: newFilter smart constructor.

Constructors

Filter' 

Fields

  • name :: Text

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

  • values :: [Text]

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

Instances

Instances details
ToQuery Filter Source # 
Instance details

Defined in Amazonka.RDS.Types.Filter

Generic Filter Source # 
Instance details

Defined in Amazonka.RDS.Types.Filter

Associated Types

type Rep Filter :: Type -> Type #

Methods

from :: Filter -> Rep Filter x #

to :: Rep Filter x -> Filter #

Read Filter Source # 
Instance details

Defined in Amazonka.RDS.Types.Filter

Show Filter Source # 
Instance details

Defined in Amazonka.RDS.Types.Filter

NFData Filter Source # 
Instance details

Defined in Amazonka.RDS.Types.Filter

Methods

rnf :: Filter -> () #

Eq Filter Source # 
Instance details

Defined in Amazonka.RDS.Types.Filter

Methods

(==) :: Filter -> Filter -> Bool #

(/=) :: Filter -> Filter -> Bool #

Hashable Filter Source # 
Instance details

Defined in Amazonka.RDS.Types.Filter

Methods

hashWithSalt :: Int -> Filter -> Int #

hash :: Filter -> Int #

type Rep Filter Source # 
Instance details

Defined in Amazonka.RDS.Types.Filter

type Rep Filter = D1 ('MetaData "Filter" "Amazonka.RDS.Types.Filter" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newFilter Source #

Create a value of Filter with all optional fields omitted.

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

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

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

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

filter_name :: Lens' Filter Text Source #

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

filter_values :: Lens' Filter [Text] Source #

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

GlobalCluster

data GlobalCluster Source #

A data type representing an Aurora global database.

See: newGlobalCluster smart constructor.

Constructors

GlobalCluster' 

Fields

  • databaseName :: Maybe Text

    The default database name within the new global database cluster.

  • deletionProtection :: Maybe Bool

    The deletion protection setting for the new global database cluster.

  • engine :: Maybe Text

    The Aurora database engine used by the global database cluster.

  • engineVersion :: Maybe Text

    Indicates the database engine version.

  • failoverState :: Maybe FailoverState

    A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

  • globalClusterArn :: Maybe Text

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

  • globalClusterIdentifier :: Maybe Text

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

  • globalClusterMembers :: Maybe [GlobalClusterMember]

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

  • globalClusterResourceId :: Maybe Text

    The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

  • status :: Maybe Text

    Specifies the current state of this global database cluster.

  • storageEncrypted :: Maybe Bool

    The storage encryption setting for the global database cluster.

Instances

Instances details
FromXML GlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalCluster

Generic GlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalCluster

Associated Types

type Rep GlobalCluster :: Type -> Type #

Read GlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalCluster

Show GlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalCluster

NFData GlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalCluster

Methods

rnf :: GlobalCluster -> () #

Eq GlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalCluster

Hashable GlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalCluster

type Rep GlobalCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalCluster

type Rep GlobalCluster = D1 ('MetaData "GlobalCluster" "Amazonka.RDS.Types.GlobalCluster" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "GlobalCluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failoverState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailoverState))))) :*: ((S1 ('MetaSel ('Just "globalClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "globalClusterMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlobalClusterMember])))) :*: (S1 ('MetaSel ('Just "globalClusterResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))

newGlobalCluster :: GlobalCluster Source #

Create a value of GlobalCluster with all optional fields omitted.

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

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

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

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

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

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

$sel:failoverState:GlobalCluster', globalCluster_failoverState - A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

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

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

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

$sel:globalClusterResourceId:GlobalCluster', globalCluster_globalClusterResourceId - The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

GlobalCluster, globalCluster_status - Specifies the current state of this global database cluster.

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

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

The default database name within the new global database cluster.

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

The deletion protection setting for the new global database cluster.

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

The Aurora database engine used by the global database cluster.

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

Indicates the database engine version.

globalCluster_failoverState :: Lens' GlobalCluster (Maybe FailoverState) Source #

A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

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

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

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

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

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

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

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

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

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

Specifies the current state of this global database cluster.

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

The storage encryption setting for the global database cluster.

GlobalClusterMember

data GlobalClusterMember Source #

A data structure with information about any primary and secondary clusters associated with an Aurora global database.

See: newGlobalClusterMember smart constructor.

Constructors

GlobalClusterMember' 

Fields

  • dbClusterArn :: Maybe Text

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

  • globalWriteForwardingStatus :: Maybe WriteForwardingStatus

    Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

  • isWriter :: Maybe Bool

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

  • readers :: Maybe [Text]

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

Instances

Instances details
FromXML GlobalClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalClusterMember

Generic GlobalClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalClusterMember

Associated Types

type Rep GlobalClusterMember :: Type -> Type #

Read GlobalClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalClusterMember

Show GlobalClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalClusterMember

NFData GlobalClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalClusterMember

Methods

rnf :: GlobalClusterMember -> () #

Eq GlobalClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalClusterMember

Hashable GlobalClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalClusterMember

type Rep GlobalClusterMember Source # 
Instance details

Defined in Amazonka.RDS.Types.GlobalClusterMember

type Rep GlobalClusterMember = D1 ('MetaData "GlobalClusterMember" "Amazonka.RDS.Types.GlobalClusterMember" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "GlobalClusterMember'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "globalWriteForwardingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WriteForwardingStatus))) :*: (S1 ('MetaSel ('Just "isWriter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "readers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newGlobalClusterMember :: GlobalClusterMember Source #

Create a value of GlobalClusterMember with all optional fields omitted.

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

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

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

$sel:globalWriteForwardingStatus:GlobalClusterMember', globalClusterMember_globalWriteForwardingStatus - Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

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

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

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

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

globalClusterMember_globalWriteForwardingStatus :: Lens' GlobalClusterMember (Maybe WriteForwardingStatus) Source #

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

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

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

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

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

IPRange

data IPRange Source #

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

See: newIPRange smart constructor.

Constructors

IPRange' 

Fields

  • cidrip :: Maybe Text

    Specifies the IP range.

  • status :: Maybe Text

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

Instances

Instances details
FromXML IPRange Source # 
Instance details

Defined in Amazonka.RDS.Types.IPRange

Generic IPRange Source # 
Instance details

Defined in Amazonka.RDS.Types.IPRange

Associated Types

type Rep IPRange :: Type -> Type #

Methods

from :: IPRange -> Rep IPRange x #

to :: Rep IPRange x -> IPRange #

Read IPRange Source # 
Instance details

Defined in Amazonka.RDS.Types.IPRange

Show IPRange Source # 
Instance details

Defined in Amazonka.RDS.Types.IPRange

NFData IPRange Source # 
Instance details

Defined in Amazonka.RDS.Types.IPRange

Methods

rnf :: IPRange -> () #

Eq IPRange Source # 
Instance details

Defined in Amazonka.RDS.Types.IPRange

Methods

(==) :: IPRange -> IPRange -> Bool #

(/=) :: IPRange -> IPRange -> Bool #

Hashable IPRange Source # 
Instance details

Defined in Amazonka.RDS.Types.IPRange

Methods

hashWithSalt :: Int -> IPRange -> Int #

hash :: IPRange -> Int #

type Rep IPRange Source # 
Instance details

Defined in Amazonka.RDS.Types.IPRange

type Rep IPRange = D1 ('MetaData "IPRange" "Amazonka.RDS.Types.IPRange" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "IPRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cidrip") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newIPRange :: IPRange Source #

Create a value of IPRange with all optional fields omitted.

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

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

$sel:cidrip:IPRange', iPRange_cidrip - Specifies the IP range.

$sel:status:IPRange', iPRange_status - Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

iPRange_cidrip :: Lens' IPRange (Maybe Text) Source #

Specifies the IP range.

iPRange_status :: Lens' IPRange (Maybe Text) Source #

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

MasterUserSecret

data MasterUserSecret Source #

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

See: newMasterUserSecret smart constructor.

Constructors

MasterUserSecret' 

Fields

  • kmsKeyId :: Maybe Text

    The Amazon Web Services KMS key identifier that is used to encrypt the secret.

  • secretArn :: Maybe Text

    The Amazon Resource Name (ARN) of the secret.

  • secretStatus :: Maybe Text

    The status of the secret.

    The possible status values include the following:

    • creating - The secret is being created.
    • active - The secret is available for normal use and rotation.
    • rotating - The secret is being rotated.
    • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.

      When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

Instances

Instances details
FromXML MasterUserSecret Source # 
Instance details

Defined in Amazonka.RDS.Types.MasterUserSecret

Generic MasterUserSecret Source # 
Instance details

Defined in Amazonka.RDS.Types.MasterUserSecret

Associated Types

type Rep MasterUserSecret :: Type -> Type #

Read MasterUserSecret Source # 
Instance details

Defined in Amazonka.RDS.Types.MasterUserSecret

Show MasterUserSecret Source # 
Instance details

Defined in Amazonka.RDS.Types.MasterUserSecret

NFData MasterUserSecret Source # 
Instance details

Defined in Amazonka.RDS.Types.MasterUserSecret

Methods

rnf :: MasterUserSecret -> () #

Eq MasterUserSecret Source # 
Instance details

Defined in Amazonka.RDS.Types.MasterUserSecret

Hashable MasterUserSecret Source # 
Instance details

Defined in Amazonka.RDS.Types.MasterUserSecret

type Rep MasterUserSecret Source # 
Instance details

Defined in Amazonka.RDS.Types.MasterUserSecret

type Rep MasterUserSecret = D1 ('MetaData "MasterUserSecret" "Amazonka.RDS.Types.MasterUserSecret" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "MasterUserSecret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "secretStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newMasterUserSecret :: MasterUserSecret Source #

Create a value of MasterUserSecret with all optional fields omitted.

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

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

$sel:kmsKeyId:MasterUserSecret', masterUserSecret_kmsKeyId - The Amazon Web Services KMS key identifier that is used to encrypt the secret.

$sel:secretArn:MasterUserSecret', masterUserSecret_secretArn - The Amazon Resource Name (ARN) of the secret.

$sel:secretStatus:MasterUserSecret', masterUserSecret_secretStatus - The status of the secret.

The possible status values include the following:

  • creating - The secret is being created.
  • active - The secret is available for normal use and rotation.
  • rotating - The secret is being rotated.
  • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.

    When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

masterUserSecret_kmsKeyId :: Lens' MasterUserSecret (Maybe Text) Source #

The Amazon Web Services KMS key identifier that is used to encrypt the secret.

masterUserSecret_secretArn :: Lens' MasterUserSecret (Maybe Text) Source #

The Amazon Resource Name (ARN) of the secret.

masterUserSecret_secretStatus :: Lens' MasterUserSecret (Maybe Text) Source #

The status of the secret.

The possible status values include the following:

  • creating - The secret is being created.
  • active - The secret is available for normal use and rotation.
  • rotating - The secret is being rotated.
  • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.

    When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

MinimumEngineVersionPerAllowedValue

data MinimumEngineVersionPerAllowedValue Source #

The minimum DB engine version required for each corresponding allowed value for an option setting.

See: newMinimumEngineVersionPerAllowedValue smart constructor.

Constructors

MinimumEngineVersionPerAllowedValue' 

Fields

Instances

Instances details
FromXML MinimumEngineVersionPerAllowedValue Source # 
Instance details

Defined in Amazonka.RDS.Types.MinimumEngineVersionPerAllowedValue

Generic MinimumEngineVersionPerAllowedValue Source # 
Instance details

Defined in Amazonka.RDS.Types.MinimumEngineVersionPerAllowedValue

Read MinimumEngineVersionPerAllowedValue Source # 
Instance details

Defined in Amazonka.RDS.Types.MinimumEngineVersionPerAllowedValue

Show MinimumEngineVersionPerAllowedValue Source # 
Instance details

Defined in Amazonka.RDS.Types.MinimumEngineVersionPerAllowedValue

NFData MinimumEngineVersionPerAllowedValue Source # 
Instance details

Defined in Amazonka.RDS.Types.MinimumEngineVersionPerAllowedValue

Eq MinimumEngineVersionPerAllowedValue Source # 
Instance details

Defined in Amazonka.RDS.Types.MinimumEngineVersionPerAllowedValue

Hashable MinimumEngineVersionPerAllowedValue Source # 
Instance details

Defined in Amazonka.RDS.Types.MinimumEngineVersionPerAllowedValue

type Rep MinimumEngineVersionPerAllowedValue Source # 
Instance details

Defined in Amazonka.RDS.Types.MinimumEngineVersionPerAllowedValue

type Rep MinimumEngineVersionPerAllowedValue = D1 ('MetaData "MinimumEngineVersionPerAllowedValue" "Amazonka.RDS.Types.MinimumEngineVersionPerAllowedValue" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "MinimumEngineVersionPerAllowedValue'" 'PrefixI 'True) (S1 ('MetaSel ('Just "allowedValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "minimumEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newMinimumEngineVersionPerAllowedValue :: MinimumEngineVersionPerAllowedValue Source #

Create a value of MinimumEngineVersionPerAllowedValue with all optional fields omitted.

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

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

$sel:allowedValue:MinimumEngineVersionPerAllowedValue', minimumEngineVersionPerAllowedValue_allowedValue - The allowed value for an option setting.

$sel:minimumEngineVersion:MinimumEngineVersionPerAllowedValue', minimumEngineVersionPerAllowedValue_minimumEngineVersion - The minimum DB engine version required for the allowed value.

Option

data Option Source #

Option details.

See: newOption smart constructor.

Constructors

Option' 

Fields

Instances

Instances details
FromXML Option Source # 
Instance details

Defined in Amazonka.RDS.Types.Option

Generic Option Source # 
Instance details

Defined in Amazonka.RDS.Types.Option

Associated Types

type Rep Option :: Type -> Type #

Methods

from :: Option -> Rep Option x #

to :: Rep Option x -> Option #

Read Option Source # 
Instance details

Defined in Amazonka.RDS.Types.Option

Show Option Source # 
Instance details

Defined in Amazonka.RDS.Types.Option

NFData Option Source # 
Instance details

Defined in Amazonka.RDS.Types.Option

Methods

rnf :: Option -> () #

Eq Option Source # 
Instance details

Defined in Amazonka.RDS.Types.Option

Methods

(==) :: Option -> Option -> Bool #

(/=) :: Option -> Option -> Bool #

Hashable Option Source # 
Instance details

Defined in Amazonka.RDS.Types.Option

Methods

hashWithSalt :: Int -> Option -> Int #

hash :: Option -> Int #

type Rep Option Source # 
Instance details

Defined in Amazonka.RDS.Types.Option

newOption :: Option Source #

Create a value of Option with all optional fields omitted.

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

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

$sel:dbSecurityGroupMemberships:Option', option_dbSecurityGroupMemberships - If the option requires access to a port, then this DB security group allows access to the port.

$sel:optionDescription:Option', option_optionDescription - The description of the option.

$sel:optionName:Option', option_optionName - The name of the option.

$sel:optionSettings:Option', option_optionSettings - The option settings for this option.

$sel:optionVersion:Option', option_optionVersion - The version of the option.

$sel:permanent:Option', option_permanent - Indicate if this option is permanent.

$sel:persistent:Option', option_persistent - Indicate if this option is persistent.

$sel:port:Option', option_port - If required, the port configured for this option to use.

$sel:vpcSecurityGroupMemberships:Option', option_vpcSecurityGroupMemberships - If the option requires access to a port, then this VPC security group allows access to the port.

option_dbSecurityGroupMemberships :: Lens' Option (Maybe [DBSecurityGroupMembership]) Source #

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

option_optionDescription :: Lens' Option (Maybe Text) Source #

The description of the option.

option_optionName :: Lens' Option (Maybe Text) Source #

The name of the option.

option_optionSettings :: Lens' Option (Maybe [OptionSetting]) Source #

The option settings for this option.

option_optionVersion :: Lens' Option (Maybe Text) Source #

The version of the option.

option_permanent :: Lens' Option (Maybe Bool) Source #

Indicate if this option is permanent.

option_persistent :: Lens' Option (Maybe Bool) Source #

Indicate if this option is persistent.

option_port :: Lens' Option (Maybe Int) Source #

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

option_vpcSecurityGroupMemberships :: Lens' Option (Maybe [VpcSecurityGroupMembership]) Source #

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

OptionConfiguration

data OptionConfiguration Source #

A list of all available options

See: newOptionConfiguration smart constructor.

Constructors

OptionConfiguration' 

Fields

Instances

Instances details
ToQuery OptionConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionConfiguration

Generic OptionConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionConfiguration

Associated Types

type Rep OptionConfiguration :: Type -> Type #

Read OptionConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionConfiguration

Show OptionConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionConfiguration

NFData OptionConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionConfiguration

Methods

rnf :: OptionConfiguration -> () #

Eq OptionConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionConfiguration

Hashable OptionConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionConfiguration

type Rep OptionConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionConfiguration

type Rep OptionConfiguration = D1 ('MetaData "OptionConfiguration" "Amazonka.RDS.Types.OptionConfiguration" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "OptionConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbSecurityGroupMemberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "optionSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OptionSetting])) :*: S1 ('MetaSel ('Just "optionVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "vpcSecurityGroupMemberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "optionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newOptionConfiguration Source #

Create a value of OptionConfiguration with all optional fields omitted.

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

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

$sel:dbSecurityGroupMemberships:OptionConfiguration', optionConfiguration_dbSecurityGroupMemberships - A list of DBSecurityGroupMembership name strings used for this option.

$sel:optionSettings:OptionConfiguration', optionConfiguration_optionSettings - The option settings to include in an option group.

$sel:optionVersion:OptionConfiguration', optionConfiguration_optionVersion - The version for the option.

$sel:port:OptionConfiguration', optionConfiguration_port - The optional port for the option.

$sel:vpcSecurityGroupMemberships:OptionConfiguration', optionConfiguration_vpcSecurityGroupMemberships - A list of VpcSecurityGroupMembership name strings used for this option.

$sel:optionName:OptionConfiguration', optionConfiguration_optionName - The configuration of options to include in a group.

optionConfiguration_dbSecurityGroupMemberships :: Lens' OptionConfiguration (Maybe [Text]) Source #

A list of DBSecurityGroupMembership name strings used for this option.

optionConfiguration_optionSettings :: Lens' OptionConfiguration (Maybe [OptionSetting]) Source #

The option settings to include in an option group.

optionConfiguration_port :: Lens' OptionConfiguration (Maybe Int) Source #

The optional port for the option.

optionConfiguration_vpcSecurityGroupMemberships :: Lens' OptionConfiguration (Maybe [Text]) Source #

A list of VpcSecurityGroupMembership name strings used for this option.

optionConfiguration_optionName :: Lens' OptionConfiguration Text Source #

The configuration of options to include in a group.

OptionGroup

data OptionGroup Source #

See: newOptionGroup smart constructor.

Constructors

OptionGroup' 

Fields

  • allowsVpcAndNonVpcInstanceMemberships :: Maybe Bool

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

  • copyTimestamp :: Maybe ISO8601

    Indicates when the option group was copied.

  • engineName :: Maybe Text

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

  • majorEngineVersion :: Maybe Text

    Indicates the major engine version associated with this option group.

  • optionGroupArn :: Maybe Text

    Specifies the Amazon Resource Name (ARN) for the option group.

  • optionGroupDescription :: Maybe Text

    Provides a description of the option group.

  • optionGroupName :: Maybe Text

    Specifies the name of the option group.

  • options :: Maybe [Option]

    Indicates what options are available in the option group.

  • sourceAccountId :: Maybe Text

    Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

  • sourceOptionGroup :: Maybe Text

    Specifies the name of the option group from which this option group is copied.

  • vpcId :: Maybe Text

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

Instances

Instances details
FromXML OptionGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroup

Generic OptionGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroup

Associated Types

type Rep OptionGroup :: Type -> Type #

Read OptionGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroup

Show OptionGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroup

NFData OptionGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroup

Methods

rnf :: OptionGroup -> () #

Eq OptionGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroup

Hashable OptionGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroup

type Rep OptionGroup Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroup

type Rep OptionGroup = D1 ('MetaData "OptionGroup" "Amazonka.RDS.Types.OptionGroup" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "OptionGroup'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allowsVpcAndNonVpcInstanceMemberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "copyTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "engineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "majorEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "optionGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "optionGroupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Option])))) :*: (S1 ('MetaSel ('Just "sourceAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sourceOptionGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newOptionGroup :: OptionGroup Source #

Create a value of OptionGroup with all optional fields omitted.

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

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

$sel:allowsVpcAndNonVpcInstanceMemberships:OptionGroup', optionGroup_allowsVpcAndNonVpcInstanceMemberships - 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.

$sel:copyTimestamp:OptionGroup', optionGroup_copyTimestamp - Indicates when the option group was copied.

$sel:engineName:OptionGroup', optionGroup_engineName - Indicates the name of the engine that this option group can be applied to.

$sel:majorEngineVersion:OptionGroup', optionGroup_majorEngineVersion - Indicates the major engine version associated with this option group.

$sel:optionGroupArn:OptionGroup', optionGroup_optionGroupArn - Specifies the Amazon Resource Name (ARN) for the option group.

$sel:optionGroupDescription:OptionGroup', optionGroup_optionGroupDescription - Provides a description of the option group.

$sel:optionGroupName:OptionGroup', optionGroup_optionGroupName - Specifies the name of the option group.

$sel:options:OptionGroup', optionGroup_options - Indicates what options are available in the option group.

$sel:sourceAccountId:OptionGroup', optionGroup_sourceAccountId - Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

$sel:sourceOptionGroup:OptionGroup', optionGroup_sourceOptionGroup - Specifies the name of the option group from which this option group is copied.

$sel:vpcId:OptionGroup', optionGroup_vpcId - 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.

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

optionGroup_copyTimestamp :: Lens' OptionGroup (Maybe UTCTime) Source #

Indicates when the option group was copied.

optionGroup_engineName :: Lens' OptionGroup (Maybe Text) Source #

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

optionGroup_majorEngineVersion :: Lens' OptionGroup (Maybe Text) Source #

Indicates the major engine version associated with this option group.

optionGroup_optionGroupArn :: Lens' OptionGroup (Maybe Text) Source #

Specifies the Amazon Resource Name (ARN) for the option group.

optionGroup_optionGroupDescription :: Lens' OptionGroup (Maybe Text) Source #

Provides a description of the option group.

optionGroup_optionGroupName :: Lens' OptionGroup (Maybe Text) Source #

Specifies the name of the option group.

optionGroup_options :: Lens' OptionGroup (Maybe [Option]) Source #

Indicates what options are available in the option group.

optionGroup_sourceAccountId :: Lens' OptionGroup (Maybe Text) Source #

Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

optionGroup_sourceOptionGroup :: Lens' OptionGroup (Maybe Text) Source #

Specifies the name of the option group from which this option group is copied.

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

OptionGroupMembership

data OptionGroupMembership Source #

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

See: newOptionGroupMembership smart constructor.

Constructors

OptionGroupMembership' 

Fields

  • optionGroupName :: Maybe Text

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

  • status :: Maybe Text

    The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

Instances

Instances details
FromXML OptionGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupMembership

Generic OptionGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupMembership

Associated Types

type Rep OptionGroupMembership :: Type -> Type #

Read OptionGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupMembership

Show OptionGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupMembership

NFData OptionGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupMembership

Methods

rnf :: OptionGroupMembership -> () #

Eq OptionGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupMembership

Hashable OptionGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupMembership

type Rep OptionGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupMembership

type Rep OptionGroupMembership = D1 ('MetaData "OptionGroupMembership" "Amazonka.RDS.Types.OptionGroupMembership" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "OptionGroupMembership'" 'PrefixI 'True) (S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newOptionGroupMembership :: OptionGroupMembership Source #

Create a value of OptionGroupMembership with all optional fields omitted.

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

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

$sel:optionGroupName:OptionGroupMembership', optionGroupMembership_optionGroupName - The name of the option group that the instance belongs to.

$sel:status:OptionGroupMembership', optionGroupMembership_status - The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

optionGroupMembership_optionGroupName :: Lens' OptionGroupMembership (Maybe Text) Source #

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

optionGroupMembership_status :: Lens' OptionGroupMembership (Maybe Text) Source #

The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

OptionGroupOption

data OptionGroupOption Source #

Available option.

See: newOptionGroupOption smart constructor.

Constructors

OptionGroupOption' 

Fields

Instances

Instances details
FromXML OptionGroupOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOption

Generic OptionGroupOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOption

Associated Types

type Rep OptionGroupOption :: Type -> Type #

Read OptionGroupOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOption

Show OptionGroupOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOption

NFData OptionGroupOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOption

Methods

rnf :: OptionGroupOption -> () #

Eq OptionGroupOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOption

Hashable OptionGroupOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOption

type Rep OptionGroupOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOption

type Rep OptionGroupOption = D1 ('MetaData "OptionGroupOption" "Amazonka.RDS.Types.OptionGroupOption" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "OptionGroupOption'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "copyableCrossAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "defaultPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "majorEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "minimumRequiredMinorEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "optionGroupOptionSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OptionGroupOptionSetting]))))) :*: (((S1 ('MetaSel ('Just "optionGroupOptionVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OptionVersion])) :*: S1 ('MetaSel ('Just "optionsConflictsWith") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "optionsDependedOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "permanent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "persistent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "portRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "requiresAutoMinorEngineVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "supportsOptionVersionDowngrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "vpcOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))))

newOptionGroupOption :: OptionGroupOption Source #

Create a value of OptionGroupOption with all optional fields omitted.

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

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

$sel:copyableCrossAccount:OptionGroupOption', optionGroupOption_copyableCrossAccount - Specifies whether the option can be copied across Amazon Web Services accounts.

$sel:defaultPort:OptionGroupOption', optionGroupOption_defaultPort - If the option requires a port, specifies the default port for the option.

$sel:description:OptionGroupOption', optionGroupOption_description - The description of the option.

$sel:engineName:OptionGroupOption', optionGroupOption_engineName - The name of the engine that this option can be applied to.

$sel:majorEngineVersion:OptionGroupOption', optionGroupOption_majorEngineVersion - Indicates the major engine version that the option is available for.

$sel:minimumRequiredMinorEngineVersion:OptionGroupOption', optionGroupOption_minimumRequiredMinorEngineVersion - The minimum required engine version for the option to be applied.

$sel:name:OptionGroupOption', optionGroupOption_name - The name of the option.

$sel:optionGroupOptionSettings:OptionGroupOption', optionGroupOption_optionGroupOptionSettings - The option settings that are available (and the default value) for each option in an option group.

$sel:optionGroupOptionVersions:OptionGroupOption', optionGroupOption_optionGroupOptionVersions - The versions that are available for the option.

$sel:optionsConflictsWith:OptionGroupOption', optionGroupOption_optionsConflictsWith - The options that conflict with this option.

$sel:optionsDependedOn:OptionGroupOption', optionGroupOption_optionsDependedOn - The options that are prerequisites for this option.

$sel:permanent:OptionGroupOption', optionGroupOption_permanent - Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

$sel:persistent:OptionGroupOption', optionGroupOption_persistent - Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

$sel:portRequired:OptionGroupOption', optionGroupOption_portRequired - Specifies whether the option requires a port.

$sel:requiresAutoMinorEngineVersionUpgrade:OptionGroupOption', optionGroupOption_requiresAutoMinorEngineVersionUpgrade - If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.

$sel:supportsOptionVersionDowngrade:OptionGroupOption', optionGroupOption_supportsOptionVersionDowngrade - If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

$sel:vpcOnly:OptionGroupOption', optionGroupOption_vpcOnly - If true, you can only use this option with a DB instance that is in a VPC.

optionGroupOption_copyableCrossAccount :: Lens' OptionGroupOption (Maybe Bool) Source #

Specifies whether the option can be copied across Amazon Web Services accounts.

optionGroupOption_defaultPort :: Lens' OptionGroupOption (Maybe Int) Source #

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

optionGroupOption_engineName :: Lens' OptionGroupOption (Maybe Text) Source #

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

optionGroupOption_majorEngineVersion :: Lens' OptionGroupOption (Maybe Text) Source #

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

optionGroupOption_minimumRequiredMinorEngineVersion :: Lens' OptionGroupOption (Maybe Text) Source #

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

optionGroupOption_optionGroupOptionSettings :: Lens' OptionGroupOption (Maybe [OptionGroupOptionSetting]) Source #

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

optionGroupOption_optionGroupOptionVersions :: Lens' OptionGroupOption (Maybe [OptionVersion]) Source #

The versions that are available for the option.

optionGroupOption_optionsConflictsWith :: Lens' OptionGroupOption (Maybe [Text]) Source #

The options that conflict with this option.

optionGroupOption_optionsDependedOn :: Lens' OptionGroupOption (Maybe [Text]) Source #

The options that are prerequisites for this option.

optionGroupOption_permanent :: Lens' OptionGroupOption (Maybe Bool) Source #

Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

optionGroupOption_persistent :: Lens' OptionGroupOption (Maybe Bool) Source #

Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

optionGroupOption_portRequired :: Lens' OptionGroupOption (Maybe Bool) Source #

Specifies whether the option requires a port.

optionGroupOption_requiresAutoMinorEngineVersionUpgrade :: Lens' OptionGroupOption (Maybe Bool) Source #

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.

optionGroupOption_supportsOptionVersionDowngrade :: Lens' OptionGroupOption (Maybe Bool) Source #

If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

optionGroupOption_vpcOnly :: Lens' OptionGroupOption (Maybe Bool) Source #

If true, you can only use this option with a DB instance that is in a VPC.

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: newOptionGroupOptionSetting smart constructor.

Constructors

OptionGroupOptionSetting' 

Fields

Instances

Instances details
FromXML OptionGroupOptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOptionSetting

Generic OptionGroupOptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOptionSetting

Associated Types

type Rep OptionGroupOptionSetting :: Type -> Type #

Read OptionGroupOptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOptionSetting

Show OptionGroupOptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOptionSetting

NFData OptionGroupOptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOptionSetting

Eq OptionGroupOptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOptionSetting

Hashable OptionGroupOptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOptionSetting

type Rep OptionGroupOptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionGroupOptionSetting

type Rep OptionGroupOptionSetting = D1 ('MetaData "OptionGroupOptionSetting" "Amazonka.RDS.Types.OptionGroupOptionSetting" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "OptionGroupOptionSetting'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allowedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "applyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isModifiable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "isRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "minimumEngineVersionPerAllowedValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MinimumEngineVersionPerAllowedValue]))) :*: (S1 ('MetaSel ('Just "settingDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "settingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newOptionGroupOptionSetting :: OptionGroupOptionSetting Source #

Create a value of OptionGroupOptionSetting with all optional fields omitted.

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

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

$sel:allowedValues:OptionGroupOptionSetting', optionGroupOptionSetting_allowedValues - Indicates the acceptable values for the option group option.

$sel:applyType:OptionGroupOptionSetting', optionGroupOptionSetting_applyType - The DB engine specific parameter type for the option group option.

$sel:defaultValue:OptionGroupOptionSetting', optionGroupOptionSetting_defaultValue - The default value for the option group option.

$sel:isModifiable:OptionGroupOptionSetting', optionGroupOptionSetting_isModifiable - Boolean value where true indicates that this option group option can be changed from the default value.

$sel:isRequired:OptionGroupOptionSetting', optionGroupOptionSetting_isRequired - Boolean value where true indicates that a value must be specified for this option setting of the option group option.

$sel:minimumEngineVersionPerAllowedValue:OptionGroupOptionSetting', optionGroupOptionSetting_minimumEngineVersionPerAllowedValue - The minimum DB engine version required for the corresponding allowed value for this option setting.

$sel:settingDescription:OptionGroupOptionSetting', optionGroupOptionSetting_settingDescription - The description of the option group option.

$sel:settingName:OptionGroupOptionSetting', optionGroupOptionSetting_settingName - The name of the option group option.

optionGroupOptionSetting_allowedValues :: Lens' OptionGroupOptionSetting (Maybe Text) Source #

Indicates the acceptable values for the option group option.

optionGroupOptionSetting_applyType :: Lens' OptionGroupOptionSetting (Maybe Text) Source #

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

optionGroupOptionSetting_defaultValue :: Lens' OptionGroupOptionSetting (Maybe Text) Source #

The default value for the option group option.

optionGroupOptionSetting_isModifiable :: Lens' OptionGroupOptionSetting (Maybe Bool) Source #

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

optionGroupOptionSetting_isRequired :: Lens' OptionGroupOptionSetting (Maybe Bool) Source #

Boolean value where true indicates that a value must be specified for this option setting of the option group option.

optionGroupOptionSetting_minimumEngineVersionPerAllowedValue :: Lens' OptionGroupOptionSetting (Maybe [MinimumEngineVersionPerAllowedValue]) Source #

The minimum DB engine version required for the corresponding allowed value for this option setting.

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: newOptionSetting smart constructor.

Constructors

OptionSetting' 

Fields

Instances

Instances details
ToQuery OptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionSetting

FromXML OptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionSetting

Generic OptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionSetting

Associated Types

type Rep OptionSetting :: Type -> Type #

Read OptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionSetting

Show OptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionSetting

NFData OptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionSetting

Methods

rnf :: OptionSetting -> () #

Eq OptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionSetting

Hashable OptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionSetting

type Rep OptionSetting Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionSetting

newOptionSetting :: OptionSetting Source #

Create a value of OptionSetting with all optional fields omitted.

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

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

$sel:allowedValues:OptionSetting', optionSetting_allowedValues - The allowed values of the option setting.

$sel:applyType:OptionSetting', optionSetting_applyType - The DB engine specific parameter type.

$sel:dataType:OptionSetting', optionSetting_dataType - The data type of the option setting.

$sel:defaultValue:OptionSetting', optionSetting_defaultValue - The default value of the option setting.

$sel:description:OptionSetting', optionSetting_description - The description of the option setting.

$sel:isCollection:OptionSetting', optionSetting_isCollection - Indicates if the option setting is part of a collection.

$sel:isModifiable:OptionSetting', optionSetting_isModifiable - A Boolean value that, when true, indicates the option setting can be modified from the default.

$sel:name:OptionSetting', optionSetting_name - The name of the option that has settings that you can set.

$sel:value:OptionSetting', optionSetting_value - The current value of the option setting.

optionSetting_allowedValues :: Lens' OptionSetting (Maybe Text) Source #

The allowed values of the option setting.

optionSetting_applyType :: Lens' OptionSetting (Maybe Text) Source #

The DB engine specific parameter type.

optionSetting_dataType :: Lens' OptionSetting (Maybe Text) Source #

The data type of the option setting.

optionSetting_defaultValue :: Lens' OptionSetting (Maybe Text) Source #

The default value of the option setting.

optionSetting_description :: Lens' OptionSetting (Maybe Text) Source #

The description of the option setting.

optionSetting_isCollection :: Lens' OptionSetting (Maybe Bool) Source #

Indicates if the option setting is part of a collection.

optionSetting_isModifiable :: Lens' OptionSetting (Maybe Bool) Source #

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

optionSetting_name :: Lens' OptionSetting (Maybe Text) Source #

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

optionSetting_value :: Lens' OptionSetting (Maybe Text) Source #

The current value of the option setting.

OptionVersion

data OptionVersion Source #

The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.

See: newOptionVersion smart constructor.

Constructors

OptionVersion' 

Fields

Instances

Instances details
FromXML OptionVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionVersion

Generic OptionVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionVersion

Associated Types

type Rep OptionVersion :: Type -> Type #

Read OptionVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionVersion

Show OptionVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionVersion

NFData OptionVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionVersion

Methods

rnf :: OptionVersion -> () #

Eq OptionVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionVersion

Hashable OptionVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionVersion

type Rep OptionVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.OptionVersion

type Rep OptionVersion = D1 ('MetaData "OptionVersion" "Amazonka.RDS.Types.OptionVersion" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "OptionVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "isDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newOptionVersion :: OptionVersion Source #

Create a value of OptionVersion with all optional fields omitted.

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

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

$sel:isDefault:OptionVersion', optionVersion_isDefault - True if the version is the default version of the option, and otherwise false.

$sel:version:OptionVersion', optionVersion_version - The version of the option.

optionVersion_isDefault :: Lens' OptionVersion (Maybe Bool) Source #

True if the version is the default version of the option, and otherwise false.

optionVersion_version :: Lens' OptionVersion (Maybe Text) Source #

The version of the option.

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: newOrderableDBInstanceOption smart constructor.

Constructors

OrderableDBInstanceOption' 

Fields

Instances

Instances details
FromXML OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OrderableDBInstanceOption

Generic OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OrderableDBInstanceOption

Associated Types

type Rep OrderableDBInstanceOption :: Type -> Type #

Read OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OrderableDBInstanceOption

Show OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OrderableDBInstanceOption

NFData OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OrderableDBInstanceOption

Eq OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OrderableDBInstanceOption

Hashable OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OrderableDBInstanceOption

type Rep OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.RDS.Types.OrderableDBInstanceOption

type Rep OrderableDBInstanceOption = D1 ('MetaData "OrderableDBInstanceOption" "Amazonka.RDS.Types.OrderableDBInstanceOption" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "OrderableDBInstanceOption'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "availabilityZoneGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AvailabilityZone]))) :*: (S1 ('MetaSel ('Just "availableProcessorFeatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AvailableProcessorFeature])) :*: S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxIopsPerDbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: (((S1 ('MetaSel ('Just "maxIopsPerGib") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "maxStorageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "maxStorageThroughputPerDbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "maxStorageThroughputPerIops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :*: ((S1 ('MetaSel ('Just "minIopsPerDbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "minIopsPerGib") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "minStorageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "minStorageThroughputPerDbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "minStorageThroughputPerIops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))))) :*: ((((S1 ('MetaSel ('Just "multiAZCapable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "outpostCapable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "readReplicaCapable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "supportedActivityStreamModes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "supportedEngineModes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "supportedNetworkTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "supportsClusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "supportsEnhancedMonitoring") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))) :*: (((S1 ('MetaSel ('Just "supportsGlobalDatabases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "supportsIAMDatabaseAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "supportsIops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "supportsKerberosAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "supportsPerformanceInsights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "supportsStorageAutoscaling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "supportsStorageEncryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "supportsStorageThroughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "vpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))))

newOrderableDBInstanceOption :: OrderableDBInstanceOption Source #

Create a value of OrderableDBInstanceOption with all optional fields omitted.

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

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

$sel:availabilityZoneGroup:OrderableDBInstanceOption', orderableDBInstanceOption_availabilityZoneGroup - The Availability Zone group for a DB instance.

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

$sel:availableProcessorFeatures:OrderableDBInstanceOption', orderableDBInstanceOption_availableProcessorFeatures - A list of the available processor features for the DB instance class of a DB instance.

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

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

$sel:engineVersion:OrderableDBInstanceOption', orderableDBInstanceOption_engineVersion - The engine version of a DB instance.

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

$sel:maxIopsPerDbInstance:OrderableDBInstanceOption', orderableDBInstanceOption_maxIopsPerDbInstance - Maximum total provisioned IOPS for a DB instance.

$sel:maxIopsPerGib:OrderableDBInstanceOption', orderableDBInstanceOption_maxIopsPerGib - Maximum provisioned IOPS per GiB for a DB instance.

$sel:maxStorageSize:OrderableDBInstanceOption', orderableDBInstanceOption_maxStorageSize - Maximum storage size for a DB instance.

$sel:maxStorageThroughputPerDbInstance:OrderableDBInstanceOption', orderableDBInstanceOption_maxStorageThroughputPerDbInstance - Maximum storage throughput for a DB instance.

$sel:maxStorageThroughputPerIops:OrderableDBInstanceOption', orderableDBInstanceOption_maxStorageThroughputPerIops - Maximum storage throughput to provisioned IOPS ratio for a DB instance.

$sel:minIopsPerDbInstance:OrderableDBInstanceOption', orderableDBInstanceOption_minIopsPerDbInstance - Minimum total provisioned IOPS for a DB instance.

$sel:minIopsPerGib:OrderableDBInstanceOption', orderableDBInstanceOption_minIopsPerGib - Minimum provisioned IOPS per GiB for a DB instance.

$sel:minStorageSize:OrderableDBInstanceOption', orderableDBInstanceOption_minStorageSize - Minimum storage size for a DB instance.

$sel:minStorageThroughputPerDbInstance:OrderableDBInstanceOption', orderableDBInstanceOption_minStorageThroughputPerDbInstance - Minimum storage throughput for a DB instance.

$sel:minStorageThroughputPerIops:OrderableDBInstanceOption', orderableDBInstanceOption_minStorageThroughputPerIops - Minimum storage throughput to provisioned IOPS ratio for a DB instance.

$sel:multiAZCapable:OrderableDBInstanceOption', orderableDBInstanceOption_multiAZCapable - Indicates whether a DB instance is Multi-AZ capable.

$sel:outpostCapable:OrderableDBInstanceOption', orderableDBInstanceOption_outpostCapable - Whether a DB instance supports RDS on Outposts.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

$sel:readReplicaCapable:OrderableDBInstanceOption', orderableDBInstanceOption_readReplicaCapable - Indicates whether a DB instance can have a read replica.

$sel:storageType:OrderableDBInstanceOption', orderableDBInstanceOption_storageType - Indicates the storage type for a DB instance.

$sel:supportedActivityStreamModes:OrderableDBInstanceOption', orderableDBInstanceOption_supportedActivityStreamModes - The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.

$sel:supportedEngineModes:OrderableDBInstanceOption', orderableDBInstanceOption_supportedEngineModes - A list of the supported DB engine modes.

$sel:supportedNetworkTypes:OrderableDBInstanceOption', orderableDBInstanceOption_supportedNetworkTypes - The network types supported by the DB instance (IPV4 or DUAL).

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

$sel:supportsClusters:OrderableDBInstanceOption', orderableDBInstanceOption_supportsClusters - Whether DB instances can be configured as a Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

$sel:supportsEnhancedMonitoring:OrderableDBInstanceOption', orderableDBInstanceOption_supportsEnhancedMonitoring - Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

$sel:supportsGlobalDatabases:OrderableDBInstanceOption', orderableDBInstanceOption_supportsGlobalDatabases - A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

$sel:supportsIAMDatabaseAuthentication:OrderableDBInstanceOption', orderableDBInstanceOption_supportsIAMDatabaseAuthentication - Indicates whether a DB instance supports IAM database authentication.

$sel:supportsIops:OrderableDBInstanceOption', orderableDBInstanceOption_supportsIops - Indicates whether a DB instance supports provisioned IOPS.

$sel:supportsKerberosAuthentication:OrderableDBInstanceOption', orderableDBInstanceOption_supportsKerberosAuthentication - Whether a DB instance supports Kerberos Authentication.

$sel:supportsPerformanceInsights:OrderableDBInstanceOption', orderableDBInstanceOption_supportsPerformanceInsights - True if a DB instance supports Performance Insights, otherwise false.

$sel:supportsStorageAutoscaling:OrderableDBInstanceOption', orderableDBInstanceOption_supportsStorageAutoscaling - Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

$sel:supportsStorageEncryption:OrderableDBInstanceOption', orderableDBInstanceOption_supportsStorageEncryption - Indicates whether a DB instance supports encrypted storage.

$sel:supportsStorageThroughput:OrderableDBInstanceOption', orderableDBInstanceOption_supportsStorageThroughput - Indicates whether a DB instance supports storage throughput.

$sel:vpc:OrderableDBInstanceOption', orderableDBInstanceOption_vpc - Indicates whether a DB instance is in a VPC.

orderableDBInstanceOption_availableProcessorFeatures :: Lens' OrderableDBInstanceOption (Maybe [AvailableProcessorFeature]) Source #

A list of the available processor features for the DB instance class of a DB instance.

orderableDBInstanceOption_maxIopsPerGib :: Lens' OrderableDBInstanceOption (Maybe Double) Source #

Maximum provisioned IOPS per GiB for a DB instance.

orderableDBInstanceOption_maxStorageThroughputPerIops :: Lens' OrderableDBInstanceOption (Maybe Double) Source #

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

orderableDBInstanceOption_minIopsPerGib :: Lens' OrderableDBInstanceOption (Maybe Double) Source #

Minimum provisioned IOPS per GiB for a DB instance.

orderableDBInstanceOption_minStorageThroughputPerIops :: Lens' OrderableDBInstanceOption (Maybe Double) Source #

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

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

Indicates whether a DB instance is Multi-AZ capable.

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

Whether a DB instance supports RDS on Outposts.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

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

Indicates whether a DB instance can have a read replica.

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

Indicates the storage type for a DB instance.

orderableDBInstanceOption_supportedActivityStreamModes :: Lens' OrderableDBInstanceOption (Maybe [Text]) Source #

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.

orderableDBInstanceOption_supportedNetworkTypes :: Lens' OrderableDBInstanceOption (Maybe [Text]) Source #

The network types supported by the DB instance (IPV4 or DUAL).

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

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

Whether DB instances can be configured as a Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

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

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

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

A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

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

Indicates whether a DB instance supports IAM database authentication.

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

Indicates whether a DB instance supports provisioned IOPS.

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

True if a DB instance supports Performance Insights, otherwise false.

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

Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

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

Indicates whether a DB instance supports encrypted storage.

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

Indicates whether a DB instance supports storage throughput.

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

Indicates whether a DB instance is in a VPC.

Outpost

data Outpost Source #

A data type that represents an Outpost.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

See: newOutpost smart constructor.

Constructors

Outpost' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the Outpost.

Instances

Instances details
FromXML Outpost Source # 
Instance details

Defined in Amazonka.RDS.Types.Outpost

Generic Outpost Source # 
Instance details

Defined in Amazonka.RDS.Types.Outpost

Associated Types

type Rep Outpost :: Type -> Type #

Methods

from :: Outpost -> Rep Outpost x #

to :: Rep Outpost x -> Outpost #

Read Outpost Source # 
Instance details

Defined in Amazonka.RDS.Types.Outpost

Show Outpost Source # 
Instance details

Defined in Amazonka.RDS.Types.Outpost

NFData Outpost Source # 
Instance details

Defined in Amazonka.RDS.Types.Outpost

Methods

rnf :: Outpost -> () #

Eq Outpost Source # 
Instance details

Defined in Amazonka.RDS.Types.Outpost

Methods

(==) :: Outpost -> Outpost -> Bool #

(/=) :: Outpost -> Outpost -> Bool #

Hashable Outpost Source # 
Instance details

Defined in Amazonka.RDS.Types.Outpost

Methods

hashWithSalt :: Int -> Outpost -> Int #

hash :: Outpost -> Int #

type Rep Outpost Source # 
Instance details

Defined in Amazonka.RDS.Types.Outpost

type Rep Outpost = D1 ('MetaData "Outpost" "Amazonka.RDS.Types.Outpost" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "Outpost'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newOutpost :: Outpost Source #

Create a value of Outpost with all optional fields omitted.

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

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

$sel:arn:Outpost', outpost_arn - The Amazon Resource Name (ARN) of the Outpost.

outpost_arn :: Lens' Outpost (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Outpost.

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: newParameter smart constructor.

Constructors

Parameter' 

Fields

Instances

Instances details
ToQuery Parameter Source # 
Instance details

Defined in Amazonka.RDS.Types.Parameter

FromXML Parameter Source # 
Instance details

Defined in Amazonka.RDS.Types.Parameter

Generic Parameter Source # 
Instance details

Defined in Amazonka.RDS.Types.Parameter

Associated Types

type Rep Parameter :: Type -> Type #

Read Parameter Source # 
Instance details

Defined in Amazonka.RDS.Types.Parameter

Show Parameter Source # 
Instance details

Defined in Amazonka.RDS.Types.Parameter

NFData Parameter Source # 
Instance details

Defined in Amazonka.RDS.Types.Parameter

Methods

rnf :: Parameter -> () #

Eq Parameter Source # 
Instance details

Defined in Amazonka.RDS.Types.Parameter

Hashable Parameter Source # 
Instance details

Defined in Amazonka.RDS.Types.Parameter

type Rep Parameter Source # 
Instance details

Defined in Amazonka.RDS.Types.Parameter

newParameter :: Parameter Source #

Create a value of Parameter with all optional fields omitted.

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

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

$sel:allowedValues:Parameter', parameter_allowedValues - Specifies the valid range of values for the parameter.

$sel:applyMethod:Parameter', parameter_applyMethod - Indicates when to apply parameter updates.

$sel:applyType:Parameter', parameter_applyType - Specifies the engine specific parameters type.

$sel:dataType:Parameter', parameter_dataType - Specifies the valid data type for the parameter.

$sel:description:Parameter', parameter_description - Provides a description of the parameter.

$sel:isModifiable:Parameter', parameter_isModifiable - Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

$sel:minimumEngineVersion:Parameter', parameter_minimumEngineVersion - The earliest engine version to which the parameter can apply.

$sel:parameterName:Parameter', parameter_parameterName - Specifies the name of the parameter.

$sel:parameterValue:Parameter', parameter_parameterValue - Specifies the value of the parameter.

$sel:source:Parameter', parameter_source - Indicates the source of the parameter value.

$sel:supportedEngineModes:Parameter', parameter_supportedEngineModes - The valid DB engine modes.

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

Specifies the valid range of values for the parameter.

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

Indicates when to apply parameter updates.

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

Specifies the engine specific parameters type.

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

Specifies the valid data type for the parameter.

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

Provides a description of the parameter.

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

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

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

The earliest engine version to which the parameter can apply.

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

Specifies the name of the parameter.

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

Specifies the value of the parameter.

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

Indicates the source of the parameter value.

PendingCloudwatchLogsExports

data PendingCloudwatchLogsExports Source #

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

See: newPendingCloudwatchLogsExports smart constructor.

Constructors

PendingCloudwatchLogsExports' 

Fields

  • logTypesToDisable :: Maybe [Text]

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

  • logTypesToEnable :: Maybe [Text]

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

Instances

Instances details
FromXML PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingCloudwatchLogsExports

Generic PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingCloudwatchLogsExports

Associated Types

type Rep PendingCloudwatchLogsExports :: Type -> Type #

Read PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingCloudwatchLogsExports

Show PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingCloudwatchLogsExports

NFData PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingCloudwatchLogsExports

Eq PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingCloudwatchLogsExports

Hashable PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingCloudwatchLogsExports

type Rep PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingCloudwatchLogsExports

type Rep PendingCloudwatchLogsExports = D1 ('MetaData "PendingCloudwatchLogsExports" "Amazonka.RDS.Types.PendingCloudwatchLogsExports" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "PendingCloudwatchLogsExports'" 'PrefixI 'True) (S1 ('MetaSel ('Just "logTypesToDisable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "logTypesToEnable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newPendingCloudwatchLogsExports :: PendingCloudwatchLogsExports Source #

Create a value of PendingCloudwatchLogsExports with all optional fields omitted.

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

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

$sel:logTypesToDisable:PendingCloudwatchLogsExports', pendingCloudwatchLogsExports_logTypesToDisable - Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

$sel:logTypesToEnable:PendingCloudwatchLogsExports', pendingCloudwatchLogsExports_logTypesToEnable - Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

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

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

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

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

PendingMaintenanceAction

data PendingMaintenanceAction Source #

Provides information about a pending maintenance action for a resource.

See: newPendingMaintenanceAction smart constructor.

Constructors

PendingMaintenanceAction' 

Fields

  • action :: Maybe Text

    The type of pending maintenance action that is available for the resource. Valid actions are system-update, db-upgrade, hardware-maintenance, and ca-certificate-rotation.

  • autoAppliedAfterDate :: Maybe ISO8601

    The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.

  • currentApplyDate :: Maybe ISO8601

    The effective date when the pending maintenance action is 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.

  • description :: Maybe Text

    A description providing more detail about the maintenance action.

  • forcedApplyDate :: Maybe ISO8601

    The date when the maintenance action is automatically applied.

    On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.

  • optInStatus :: Maybe Text

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

Instances

Instances details
FromXML PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingMaintenanceAction

Generic PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingMaintenanceAction

Associated Types

type Rep PendingMaintenanceAction :: Type -> Type #

Read PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingMaintenanceAction

Show PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingMaintenanceAction

NFData PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingMaintenanceAction

Eq PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingMaintenanceAction

Hashable PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingMaintenanceAction

type Rep PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingMaintenanceAction

type Rep PendingMaintenanceAction = D1 ('MetaData "PendingMaintenanceAction" "Amazonka.RDS.Types.PendingMaintenanceAction" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "PendingMaintenanceAction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "autoAppliedAfterDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "currentApplyDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "forcedApplyDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "optInStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newPendingMaintenanceAction :: PendingMaintenanceAction Source #

Create a value of PendingMaintenanceAction with all optional fields omitted.

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

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

$sel:action:PendingMaintenanceAction', pendingMaintenanceAction_action - The type of pending maintenance action that is available for the resource. Valid actions are system-update, db-upgrade, hardware-maintenance, and ca-certificate-rotation.

$sel:autoAppliedAfterDate:PendingMaintenanceAction', pendingMaintenanceAction_autoAppliedAfterDate - The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.

$sel:currentApplyDate:PendingMaintenanceAction', pendingMaintenanceAction_currentApplyDate - The effective date when the pending maintenance action is 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.

$sel:description:PendingMaintenanceAction', pendingMaintenanceAction_description - A description providing more detail about the maintenance action.

$sel:forcedApplyDate:PendingMaintenanceAction', pendingMaintenanceAction_forcedApplyDate - The date when the maintenance action is automatically applied.

On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.

$sel:optInStatus:PendingMaintenanceAction', pendingMaintenanceAction_optInStatus - Indicates the type of opt-in request that has been received for the resource.

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

The type of pending maintenance action that is available for the resource. Valid actions are system-update, db-upgrade, hardware-maintenance, and ca-certificate-rotation.

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

The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.

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

The effective date when the pending maintenance action is 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.

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

A description providing more detail about the maintenance action.

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

The date when the maintenance action is automatically applied.

On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.

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

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

PendingModifiedValues

data PendingModifiedValues Source #

This data type is used as a response element in the ModifyDBInstance operation and contains changes that will be applied during the next maintenance window.

See: newPendingModifiedValues smart constructor.

Constructors

PendingModifiedValues' 

Fields

Instances

Instances details
FromXML PendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingModifiedValues

Generic PendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingModifiedValues

Associated Types

type Rep PendingModifiedValues :: Type -> Type #

Read PendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingModifiedValues

Show PendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingModifiedValues

NFData PendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingModifiedValues

Methods

rnf :: PendingModifiedValues -> () #

Eq PendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingModifiedValues

Hashable PendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingModifiedValues

type Rep PendingModifiedValues Source # 
Instance details

Defined in Amazonka.RDS.Types.PendingModifiedValues

type Rep PendingModifiedValues = D1 ('MetaData "PendingModifiedValues" "Amazonka.RDS.Types.PendingModifiedValues" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "PendingModifiedValues'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "automationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutomationMode))) :*: (S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "cACertificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iAMDatabaseAuthenticationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))) :*: (((S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "masterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "pendingCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PendingCloudwatchLogsExports))))) :*: ((S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "processorFeatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProcessorFeature]))) :*: (S1 ('MetaSel ('Just "resumeFullAutomationModeTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "storageThroughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newPendingModifiedValues :: PendingModifiedValues Source #

Create a value of PendingModifiedValues with all optional fields omitted.

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

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

$sel:allocatedStorage:PendingModifiedValues', pendingModifiedValues_allocatedStorage - The allocated storage size for the DB instance specified in gibibytes (GiB).

$sel:automationMode:PendingModifiedValues', pendingModifiedValues_automationMode - The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

$sel:backupRetentionPeriod:PendingModifiedValues', pendingModifiedValues_backupRetentionPeriod - The number of days for which automated backups are retained.

$sel:cACertificateIdentifier:PendingModifiedValues', pendingModifiedValues_cACertificateIdentifier - The identifier of the CA certificate for the DB instance.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

$sel:dbInstanceClass:PendingModifiedValues', pendingModifiedValues_dbInstanceClass - The name of the compute and memory capacity class for the DB instance.

$sel:dbInstanceIdentifier:PendingModifiedValues', pendingModifiedValues_dbInstanceIdentifier - The database identifier for the DB instance.

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

$sel:engineVersion:PendingModifiedValues', pendingModifiedValues_engineVersion - The database engine version.

$sel:iAMDatabaseAuthenticationEnabled:PendingModifiedValues', pendingModifiedValues_iAMDatabaseAuthenticationEnabled - Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

$sel:iops:PendingModifiedValues', pendingModifiedValues_iops - The Provisioned IOPS value for the DB instance.

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

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

$sel:masterUserPassword:PendingModifiedValues', pendingModifiedValues_masterUserPassword - The master credentials for the DB instance.

$sel:multiAZ:PendingModifiedValues', pendingModifiedValues_multiAZ - A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.

$sel:pendingCloudwatchLogsExports:PendingModifiedValues', pendingModifiedValues_pendingCloudwatchLogsExports - Undocumented member.

$sel:port:PendingModifiedValues', pendingModifiedValues_port - The port for the DB instance.

$sel:processorFeatures:PendingModifiedValues', pendingModifiedValues_processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

$sel:resumeFullAutomationModeTime:PendingModifiedValues', pendingModifiedValues_resumeFullAutomationModeTime - The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

$sel:storageThroughput:PendingModifiedValues', pendingModifiedValues_storageThroughput - The storage throughput of the DB instance.

$sel:storageType:PendingModifiedValues', pendingModifiedValues_storageType - The storage type of the DB instance.

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

The allocated storage size for the DB instance specified in gibibytes (GiB).

pendingModifiedValues_automationMode :: Lens' PendingModifiedValues (Maybe AutomationMode) Source #

The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

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

The number of days for which automated backups are retained.

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

The identifier of the CA certificate for the DB instance.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

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

The name of the compute and memory capacity class for the DB instance.

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

Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

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

The Provisioned IOPS value for the DB instance.

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

The license model for the DB instance.

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

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

A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.

pendingModifiedValues_processorFeatures :: Lens' PendingModifiedValues (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

pendingModifiedValues_resumeFullAutomationModeTime :: Lens' PendingModifiedValues (Maybe UTCTime) Source #

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

ProcessorFeature

data ProcessorFeature Source #

Contains the processor features of a DB instance class.

To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

  • CreateDBInstance
  • ModifyDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceFromS3
  • RestoreDBInstanceToPointInTime

You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

In addition, you can use the following actions for DB instance class processor information:

  • DescribeDBInstances
  • DescribeDBSnapshots
  • DescribeValidDBInstanceModifications

If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:

  • You are accessing an Oracle DB instance.
  • Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
  • The current number CPU cores and threads is set to a non-default value.

For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

See: newProcessorFeature smart constructor.

Constructors

ProcessorFeature' 

Fields

  • name :: Maybe Text

    The name of the processor feature. Valid names are coreCount and threadsPerCore.

  • value :: Maybe Text

    The value of a processor feature name.

Instances

Instances details
ToQuery ProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.ProcessorFeature

FromXML ProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.ProcessorFeature

Generic ProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.ProcessorFeature

Associated Types

type Rep ProcessorFeature :: Type -> Type #

Read ProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.ProcessorFeature

Show ProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.ProcessorFeature

NFData ProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.ProcessorFeature

Methods

rnf :: ProcessorFeature -> () #

Eq ProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.ProcessorFeature

Hashable ProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.ProcessorFeature

type Rep ProcessorFeature Source # 
Instance details

Defined in Amazonka.RDS.Types.ProcessorFeature

type Rep ProcessorFeature = D1 ('MetaData "ProcessorFeature" "Amazonka.RDS.Types.ProcessorFeature" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ProcessorFeature'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newProcessorFeature :: ProcessorFeature Source #

Create a value of ProcessorFeature with all optional fields omitted.

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

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

$sel:name:ProcessorFeature', processorFeature_name - The name of the processor feature. Valid names are coreCount and threadsPerCore.

$sel:value:ProcessorFeature', processorFeature_value - The value of a processor feature name.

processorFeature_name :: Lens' ProcessorFeature (Maybe Text) Source #

The name of the processor feature. Valid names are coreCount and threadsPerCore.

processorFeature_value :: Lens' ProcessorFeature (Maybe Text) Source #

The value of a processor feature name.

Range

data Range Source #

A range of integer values.

See: newRange smart constructor.

Constructors

Range' 

Fields

  • from :: Maybe Int

    The minimum value in the range.

  • step :: Maybe Int

    The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

  • to :: Maybe Int

    The maximum value in the range.

Instances

Instances details
FromXML Range Source # 
Instance details

Defined in Amazonka.RDS.Types.Range

Methods

parseXML :: [Node] -> Either String Range #

Generic Range Source # 
Instance details

Defined in Amazonka.RDS.Types.Range

Associated Types

type Rep Range :: Type -> Type #

Methods

from :: Range -> Rep Range x #

to :: Rep Range x -> Range #

Read Range Source # 
Instance details

Defined in Amazonka.RDS.Types.Range

Show Range Source # 
Instance details

Defined in Amazonka.RDS.Types.Range

Methods

showsPrec :: Int -> Range -> ShowS #

show :: Range -> String #

showList :: [Range] -> ShowS #

NFData Range Source # 
Instance details

Defined in Amazonka.RDS.Types.Range

Methods

rnf :: Range -> () #

Eq Range Source # 
Instance details

Defined in Amazonka.RDS.Types.Range

Methods

(==) :: Range -> Range -> Bool #

(/=) :: Range -> Range -> Bool #

Hashable Range Source # 
Instance details

Defined in Amazonka.RDS.Types.Range

Methods

hashWithSalt :: Int -> Range -> Int #

hash :: Range -> Int #

type Rep Range Source # 
Instance details

Defined in Amazonka.RDS.Types.Range

type Rep Range = D1 ('MetaData "Range" "Amazonka.RDS.Types.Range" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "Range'" 'PrefixI 'True) (S1 ('MetaSel ('Just "from") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "step") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "to") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newRange :: Range Source #

Create a value of Range with all optional fields omitted.

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

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

$sel:from:Range', range_from - The minimum value in the range.

$sel:step:Range', range_step - The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

$sel:to:Range', range_to - The maximum value in the range.

range_from :: Lens' Range (Maybe Int) Source #

The minimum value in the range.

range_step :: Lens' Range (Maybe Int) Source #

The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

range_to :: Lens' Range (Maybe Int) Source #

The maximum value in the range.

RecurringCharge

data RecurringCharge Source #

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

See: newRecurringCharge smart constructor.

Constructors

RecurringCharge' 

Fields

Instances

Instances details
FromXML RecurringCharge Source # 
Instance details

Defined in Amazonka.RDS.Types.RecurringCharge

Generic RecurringCharge Source # 
Instance details

Defined in Amazonka.RDS.Types.RecurringCharge

Associated Types

type Rep RecurringCharge :: Type -> Type #

Read RecurringCharge Source # 
Instance details

Defined in Amazonka.RDS.Types.RecurringCharge

Show RecurringCharge Source # 
Instance details

Defined in Amazonka.RDS.Types.RecurringCharge

NFData RecurringCharge Source # 
Instance details

Defined in Amazonka.RDS.Types.RecurringCharge

Methods

rnf :: RecurringCharge -> () #

Eq RecurringCharge Source # 
Instance details

Defined in Amazonka.RDS.Types.RecurringCharge

Hashable RecurringCharge Source # 
Instance details

Defined in Amazonka.RDS.Types.RecurringCharge

type Rep RecurringCharge Source # 
Instance details

Defined in Amazonka.RDS.Types.RecurringCharge

type Rep RecurringCharge = D1 ('MetaData "RecurringCharge" "Amazonka.RDS.Types.RecurringCharge" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "RecurringCharge'" 'PrefixI 'True) (S1 ('MetaSel ('Just "recurringChargeAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "recurringChargeFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newRecurringCharge :: RecurringCharge Source #

Create a value of RecurringCharge with all optional fields omitted.

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

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

$sel:recurringChargeAmount:RecurringCharge', recurringCharge_recurringChargeAmount - The amount of the recurring charge.

$sel:recurringChargeFrequency:RecurringCharge', recurringCharge_recurringChargeFrequency - The frequency of the recurring charge.

ReservedDBInstance

data ReservedDBInstance Source #

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

See: newReservedDBInstance smart constructor.

Constructors

ReservedDBInstance' 

Fields

Instances

Instances details
FromXML ReservedDBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstance

Generic ReservedDBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstance

Associated Types

type Rep ReservedDBInstance :: Type -> Type #

Read ReservedDBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstance

Show ReservedDBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstance

NFData ReservedDBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstance

Methods

rnf :: ReservedDBInstance -> () #

Eq ReservedDBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstance

Hashable ReservedDBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstance

type Rep ReservedDBInstance Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstance

type Rep ReservedDBInstance = D1 ('MetaData "ReservedDBInstance" "Amazonka.RDS.Types.ReservedDBInstance" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ReservedDBInstance'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "currencyCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbInstanceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "fixedPrice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "leaseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "offeringType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "productDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recurringCharges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RecurringCharge]))) :*: (S1 ('MetaSel ('Just "reservedDBInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "reservedDBInstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "reservedDBInstancesOfferingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "usagePrice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))))

newReservedDBInstance :: ReservedDBInstance Source #

Create a value of ReservedDBInstance with all optional fields omitted.

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

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

$sel:currencyCode:ReservedDBInstance', reservedDBInstance_currencyCode - The currency code for the reserved DB instance.

$sel:dbInstanceClass:ReservedDBInstance', reservedDBInstance_dbInstanceClass - The DB instance class for the reserved DB instance.

$sel:dbInstanceCount:ReservedDBInstance', reservedDBInstance_dbInstanceCount - The number of reserved DB instances.

$sel:duration:ReservedDBInstance', reservedDBInstance_duration - The duration of the reservation in seconds.

$sel:fixedPrice:ReservedDBInstance', reservedDBInstance_fixedPrice - The fixed price charged for this reserved DB instance.

$sel:leaseId:ReservedDBInstance', reservedDBInstance_leaseId - The unique identifier for the lease associated with the reserved DB instance.

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

$sel:multiAZ:ReservedDBInstance', reservedDBInstance_multiAZ - Indicates if the reservation applies to Multi-AZ deployments.

$sel:offeringType:ReservedDBInstance', reservedDBInstance_offeringType - The offering type of this reserved DB instance.

$sel:productDescription:ReservedDBInstance', reservedDBInstance_productDescription - The description of the reserved DB instance.

$sel:recurringCharges:ReservedDBInstance', reservedDBInstance_recurringCharges - The recurring price charged to run this reserved DB instance.

$sel:reservedDBInstanceArn:ReservedDBInstance', reservedDBInstance_reservedDBInstanceArn - The Amazon Resource Name (ARN) for the reserved DB instance.

$sel:reservedDBInstanceId:ReservedDBInstance', reservedDBInstance_reservedDBInstanceId - The unique identifier for the reservation.

$sel:reservedDBInstancesOfferingId:ReservedDBInstance', reservedDBInstance_reservedDBInstancesOfferingId - The offering identifier.

$sel:startTime:ReservedDBInstance', reservedDBInstance_startTime - The time the reservation started.

$sel:state:ReservedDBInstance', reservedDBInstance_state - The state of the reserved DB instance.

$sel:usagePrice:ReservedDBInstance', reservedDBInstance_usagePrice - The hourly price charged for this reserved DB instance.

reservedDBInstance_currencyCode :: Lens' ReservedDBInstance (Maybe Text) Source #

The currency code for the reserved DB instance.

reservedDBInstance_dbInstanceClass :: Lens' ReservedDBInstance (Maybe Text) Source #

The DB instance class for the reserved DB instance.

reservedDBInstance_duration :: Lens' ReservedDBInstance (Maybe Int) Source #

The duration of the reservation in seconds.

reservedDBInstance_fixedPrice :: Lens' ReservedDBInstance (Maybe Double) Source #

The fixed price charged for this reserved DB instance.

reservedDBInstance_leaseId :: Lens' ReservedDBInstance (Maybe Text) Source #

The unique identifier for the lease associated with the reserved DB instance.

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

reservedDBInstance_multiAZ :: Lens' ReservedDBInstance (Maybe Bool) Source #

Indicates if the reservation applies to Multi-AZ deployments.

reservedDBInstance_offeringType :: Lens' ReservedDBInstance (Maybe Text) Source #

The offering type of this reserved DB instance.

reservedDBInstance_productDescription :: Lens' ReservedDBInstance (Maybe Text) Source #

The description of the reserved DB instance.

reservedDBInstance_recurringCharges :: Lens' ReservedDBInstance (Maybe [RecurringCharge]) Source #

The recurring price charged to run this reserved DB instance.

reservedDBInstance_reservedDBInstanceArn :: Lens' ReservedDBInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) for the reserved DB instance.

reservedDBInstance_reservedDBInstanceId :: Lens' ReservedDBInstance (Maybe Text) Source #

The unique identifier for the reservation.

reservedDBInstance_state :: Lens' ReservedDBInstance (Maybe Text) Source #

The state of the reserved DB instance.

reservedDBInstance_usagePrice :: Lens' ReservedDBInstance (Maybe Double) Source #

The hourly price charged for this reserved DB instance.

ReservedDBInstancesOffering

data ReservedDBInstancesOffering Source #

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

See: newReservedDBInstancesOffering smart constructor.

Constructors

ReservedDBInstancesOffering' 

Fields

Instances

Instances details
FromXML ReservedDBInstancesOffering Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstancesOffering

Generic ReservedDBInstancesOffering Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstancesOffering

Associated Types

type Rep ReservedDBInstancesOffering :: Type -> Type #

Read ReservedDBInstancesOffering Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstancesOffering

Show ReservedDBInstancesOffering Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstancesOffering

NFData ReservedDBInstancesOffering Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstancesOffering

Eq ReservedDBInstancesOffering Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstancesOffering

Hashable ReservedDBInstancesOffering Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstancesOffering

type Rep ReservedDBInstancesOffering Source # 
Instance details

Defined in Amazonka.RDS.Types.ReservedDBInstancesOffering

type Rep ReservedDBInstancesOffering = D1 ('MetaData "ReservedDBInstancesOffering" "Amazonka.RDS.Types.ReservedDBInstancesOffering" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ReservedDBInstancesOffering'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "currencyCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "fixedPrice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "offeringType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "productDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "recurringCharges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RecurringCharge])) :*: (S1 ('MetaSel ('Just "reservedDBInstancesOfferingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "usagePrice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))))

newReservedDBInstancesOffering :: ReservedDBInstancesOffering Source #

Create a value of ReservedDBInstancesOffering with all optional fields omitted.

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

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

$sel:currencyCode:ReservedDBInstancesOffering', reservedDBInstancesOffering_currencyCode - The currency code for the reserved DB instance offering.

$sel:dbInstanceClass:ReservedDBInstancesOffering', reservedDBInstancesOffering_dbInstanceClass - The DB instance class for the reserved DB instance.

$sel:duration:ReservedDBInstancesOffering', reservedDBInstancesOffering_duration - The duration of the offering in seconds.

$sel:fixedPrice:ReservedDBInstancesOffering', reservedDBInstancesOffering_fixedPrice - The fixed price charged for this offering.

$sel:multiAZ:ReservedDBInstancesOffering', reservedDBInstancesOffering_multiAZ - Indicates if the offering applies to Multi-AZ deployments.

$sel:offeringType:ReservedDBInstancesOffering', reservedDBInstancesOffering_offeringType - The offering type.

$sel:productDescription:ReservedDBInstancesOffering', reservedDBInstancesOffering_productDescription - The database engine used by the offering.

$sel:recurringCharges:ReservedDBInstancesOffering', reservedDBInstancesOffering_recurringCharges - The recurring price charged to run this reserved DB instance.

$sel:reservedDBInstancesOfferingId:ReservedDBInstancesOffering', reservedDBInstancesOffering_reservedDBInstancesOfferingId - The offering identifier.

$sel:usagePrice:ReservedDBInstancesOffering', reservedDBInstancesOffering_usagePrice - The hourly price charged for this offering.

reservedDBInstancesOffering_currencyCode :: Lens' ReservedDBInstancesOffering (Maybe Text) Source #

The currency code for the reserved DB instance offering.

reservedDBInstancesOffering_dbInstanceClass :: Lens' ReservedDBInstancesOffering (Maybe Text) Source #

The DB instance class for the reserved DB instance.

reservedDBInstancesOffering_multiAZ :: Lens' ReservedDBInstancesOffering (Maybe Bool) Source #

Indicates if the offering applies to Multi-AZ deployments.

reservedDBInstancesOffering_recurringCharges :: Lens' ReservedDBInstancesOffering (Maybe [RecurringCharge]) Source #

The recurring price charged to run this reserved DB instance.

ResourcePendingMaintenanceActions

data ResourcePendingMaintenanceActions Source #

Describes the pending maintenance actions for a resource.

See: newResourcePendingMaintenanceActions smart constructor.

Constructors

ResourcePendingMaintenanceActions' 

Fields

Instances

Instances details
FromXML ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.RDS.Types.ResourcePendingMaintenanceActions

Generic ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.RDS.Types.ResourcePendingMaintenanceActions

Associated Types

type Rep ResourcePendingMaintenanceActions :: Type -> Type #

Read ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.RDS.Types.ResourcePendingMaintenanceActions

Show ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.RDS.Types.ResourcePendingMaintenanceActions

NFData ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.RDS.Types.ResourcePendingMaintenanceActions

Eq ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.RDS.Types.ResourcePendingMaintenanceActions

Hashable ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.RDS.Types.ResourcePendingMaintenanceActions

type Rep ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.RDS.Types.ResourcePendingMaintenanceActions

type Rep ResourcePendingMaintenanceActions = D1 ('MetaData "ResourcePendingMaintenanceActions" "Amazonka.RDS.Types.ResourcePendingMaintenanceActions" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ResourcePendingMaintenanceActions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pendingMaintenanceActionDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PendingMaintenanceAction])) :*: S1 ('MetaSel ('Just "resourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newResourcePendingMaintenanceActions :: ResourcePendingMaintenanceActions Source #

Create a value of ResourcePendingMaintenanceActions with all optional fields omitted.

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

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

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

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

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

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

resourcePendingMaintenanceActions_resourceIdentifier :: Lens' ResourcePendingMaintenanceActions (Maybe Text) Source #

The ARN of the resource that has pending maintenance actions.

RestoreWindow

data RestoreWindow Source #

Earliest and latest time an instance can be restored to:

See: newRestoreWindow smart constructor.

Constructors

RestoreWindow' 

Fields

Instances

Instances details
FromXML RestoreWindow Source # 
Instance details

Defined in Amazonka.RDS.Types.RestoreWindow

Generic RestoreWindow Source # 
Instance details

Defined in Amazonka.RDS.Types.RestoreWindow

Associated Types

type Rep RestoreWindow :: Type -> Type #

Read RestoreWindow Source # 
Instance details

Defined in Amazonka.RDS.Types.RestoreWindow

Show RestoreWindow Source # 
Instance details

Defined in Amazonka.RDS.Types.RestoreWindow

NFData RestoreWindow Source # 
Instance details

Defined in Amazonka.RDS.Types.RestoreWindow

Methods

rnf :: RestoreWindow -> () #

Eq RestoreWindow Source # 
Instance details

Defined in Amazonka.RDS.Types.RestoreWindow

Hashable RestoreWindow Source # 
Instance details

Defined in Amazonka.RDS.Types.RestoreWindow

type Rep RestoreWindow Source # 
Instance details

Defined in Amazonka.RDS.Types.RestoreWindow

type Rep RestoreWindow = D1 ('MetaData "RestoreWindow" "Amazonka.RDS.Types.RestoreWindow" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "RestoreWindow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "earliestTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "latestTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))

newRestoreWindow :: RestoreWindow Source #

Create a value of RestoreWindow with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:earliestTime:RestoreWindow', restoreWindow_earliestTime - The earliest time you can restore an instance to.

$sel:latestTime:RestoreWindow', restoreWindow_latestTime - The latest time you can restore an instance to.

restoreWindow_earliestTime :: Lens' RestoreWindow (Maybe UTCTime) Source #

The earliest time you can restore an instance to.

restoreWindow_latestTime :: Lens' RestoreWindow (Maybe UTCTime) Source #

The latest time you can restore an instance to.

ScalingConfiguration

data ScalingConfiguration Source #

Contains the scaling configuration of an Aurora Serverless v1 DB cluster.

For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

See: newScalingConfiguration smart constructor.

Constructors

ScalingConfiguration' 

Fields

  • autoPause :: Maybe Bool

    A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

    If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

  • maxCapacity :: Maybe Int

    The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

    For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

    For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

    The maximum capacity must be greater than or equal to the minimum capacity.

  • minCapacity :: Maybe Int

    The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

    For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

    For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

    The minimum capacity must be less than or equal to the maximum capacity.

  • secondsBeforeTimeout :: Maybe Int

    The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

    Specify a value between 60 and 600 seconds.

  • secondsUntilAutoPause :: Maybe Int

    The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

    Specify a value between 300 and 86,400 seconds.

  • timeoutAction :: Maybe Text

    The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

    ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

    RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

    If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.

    For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

Instances

Instances details
ToQuery ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfiguration

Generic ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfiguration

Associated Types

type Rep ScalingConfiguration :: Type -> Type #

Read ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfiguration

Show ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfiguration

NFData ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfiguration

Methods

rnf :: ScalingConfiguration -> () #

Eq ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfiguration

Hashable ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfiguration

type Rep ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfiguration

type Rep ScalingConfiguration = D1 ('MetaData "ScalingConfiguration" "Amazonka.RDS.Types.ScalingConfiguration" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ScalingConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "autoPause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "minCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "secondsBeforeTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "secondsUntilAutoPause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "timeoutAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newScalingConfiguration :: ScalingConfiguration Source #

Create a value of ScalingConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:autoPause:ScalingConfiguration', scalingConfiguration_autoPause - A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

$sel:maxCapacity:ScalingConfiguration', scalingConfiguration_maxCapacity - The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The maximum capacity must be greater than or equal to the minimum capacity.

$sel:minCapacity:ScalingConfiguration', scalingConfiguration_minCapacity - The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The minimum capacity must be less than or equal to the maximum capacity.

$sel:secondsBeforeTimeout:ScalingConfiguration', scalingConfiguration_secondsBeforeTimeout - The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

Specify a value between 60 and 600 seconds.

$sel:secondsUntilAutoPause:ScalingConfiguration', scalingConfiguration_secondsUntilAutoPause - The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

Specify a value between 300 and 86,400 seconds.

$sel:timeoutAction:ScalingConfiguration', scalingConfiguration_timeoutAction - The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

scalingConfiguration_autoPause :: Lens' ScalingConfiguration (Maybe Bool) Source #

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

scalingConfiguration_maxCapacity :: Lens' ScalingConfiguration (Maybe Int) Source #

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The maximum capacity must be greater than or equal to the minimum capacity.

scalingConfiguration_minCapacity :: Lens' ScalingConfiguration (Maybe Int) Source #

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The minimum capacity must be less than or equal to the maximum capacity.

scalingConfiguration_secondsBeforeTimeout :: Lens' ScalingConfiguration (Maybe Int) Source #

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

Specify a value between 60 and 600 seconds.

scalingConfiguration_secondsUntilAutoPause :: Lens' ScalingConfiguration (Maybe Int) Source #

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

Specify a value between 300 and 86,400 seconds.

scalingConfiguration_timeoutAction :: Lens' ScalingConfiguration (Maybe Text) Source #

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

ScalingConfigurationInfo

data ScalingConfigurationInfo Source #

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

See: newScalingConfigurationInfo smart constructor.

Constructors

ScalingConfigurationInfo' 

Fields

  • autoPause :: Maybe Bool

    A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

    When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

  • maxCapacity :: Maybe Int

    The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

  • minCapacity :: Maybe Int

    The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

  • secondsBeforeTimeout :: Maybe Int

    The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.

  • secondsUntilAutoPause :: Maybe Int

    The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).

  • timeoutAction :: Maybe Text

    The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange.

    ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

    RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

Instances

Instances details
FromXML ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

Generic ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

Associated Types

type Rep ScalingConfigurationInfo :: Type -> Type #

Read ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

Show ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

NFData ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

Eq ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

Hashable ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

type Rep ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ScalingConfigurationInfo

type Rep ScalingConfigurationInfo = D1 ('MetaData "ScalingConfigurationInfo" "Amazonka.RDS.Types.ScalingConfigurationInfo" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ScalingConfigurationInfo'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "autoPause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "minCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "secondsBeforeTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "secondsUntilAutoPause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "timeoutAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newScalingConfigurationInfo :: ScalingConfigurationInfo Source #

Create a value of ScalingConfigurationInfo with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:autoPause:ScalingConfigurationInfo', scalingConfigurationInfo_autoPause - A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

$sel:maxCapacity:ScalingConfigurationInfo', scalingConfigurationInfo_maxCapacity - The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

$sel:minCapacity:ScalingConfigurationInfo', scalingConfigurationInfo_minCapacity - The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

$sel:secondsBeforeTimeout:ScalingConfigurationInfo', scalingConfigurationInfo_secondsBeforeTimeout - The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.

$sel:secondsUntilAutoPause:ScalingConfigurationInfo', scalingConfigurationInfo_secondsUntilAutoPause - The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).

$sel:timeoutAction:ScalingConfigurationInfo', scalingConfigurationInfo_timeoutAction - The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

scalingConfigurationInfo_autoPause :: Lens' ScalingConfigurationInfo (Maybe Bool) Source #

A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

scalingConfigurationInfo_maxCapacity :: Lens' ScalingConfigurationInfo (Maybe Int) Source #

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

scalingConfigurationInfo_minCapacity :: Lens' ScalingConfigurationInfo (Maybe Int) Source #

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

scalingConfigurationInfo_secondsBeforeTimeout :: Lens' ScalingConfigurationInfo (Maybe Int) Source #

The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.

scalingConfigurationInfo_secondsUntilAutoPause :: Lens' ScalingConfigurationInfo (Maybe Int) Source #

The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).

scalingConfigurationInfo_timeoutAction :: Lens' ScalingConfigurationInfo (Maybe Text) Source #

The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

ServerlessV2ScalingConfiguration

data ServerlessV2ScalingConfiguration Source #

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.

See: newServerlessV2ScalingConfiguration smart constructor.

Constructors

ServerlessV2ScalingConfiguration' 

Fields

  • maxCapacity :: Maybe Double

    The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.

  • minCapacity :: Maybe Double

    The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

Instances

Instances details
ToQuery ServerlessV2ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfiguration

Generic ServerlessV2ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfiguration

Associated Types

type Rep ServerlessV2ScalingConfiguration :: Type -> Type #

Read ServerlessV2ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfiguration

Show ServerlessV2ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfiguration

NFData ServerlessV2ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfiguration

Eq ServerlessV2ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfiguration

Hashable ServerlessV2ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfiguration

type Rep ServerlessV2ScalingConfiguration Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfiguration

type Rep ServerlessV2ScalingConfiguration = D1 ('MetaData "ServerlessV2ScalingConfiguration" "Amazonka.RDS.Types.ServerlessV2ScalingConfiguration" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ServerlessV2ScalingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "minCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newServerlessV2ScalingConfiguration :: ServerlessV2ScalingConfiguration Source #

Create a value of ServerlessV2ScalingConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxCapacity:ServerlessV2ScalingConfiguration', serverlessV2ScalingConfiguration_maxCapacity - The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.

$sel:minCapacity:ServerlessV2ScalingConfiguration', serverlessV2ScalingConfiguration_minCapacity - The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

serverlessV2ScalingConfiguration_maxCapacity :: Lens' ServerlessV2ScalingConfiguration (Maybe Double) Source #

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.

serverlessV2ScalingConfiguration_minCapacity :: Lens' ServerlessV2ScalingConfiguration (Maybe Double) Source #

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

ServerlessV2ScalingConfigurationInfo

data ServerlessV2ScalingConfigurationInfo Source #

Shows the scaling configuration for an Aurora Serverless v2 DB cluster.

For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.

See: newServerlessV2ScalingConfigurationInfo smart constructor.

Constructors

ServerlessV2ScalingConfigurationInfo' 

Fields

  • maxCapacity :: Maybe Double

    The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.

  • minCapacity :: Maybe Double

    The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

Instances

Instances details
FromXML ServerlessV2ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfigurationInfo

Generic ServerlessV2ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfigurationInfo

Read ServerlessV2ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfigurationInfo

Show ServerlessV2ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfigurationInfo

NFData ServerlessV2ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfigurationInfo

Eq ServerlessV2ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfigurationInfo

Hashable ServerlessV2ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfigurationInfo

type Rep ServerlessV2ScalingConfigurationInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.ServerlessV2ScalingConfigurationInfo

type Rep ServerlessV2ScalingConfigurationInfo = D1 ('MetaData "ServerlessV2ScalingConfigurationInfo" "Amazonka.RDS.Types.ServerlessV2ScalingConfigurationInfo" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ServerlessV2ScalingConfigurationInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "minCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newServerlessV2ScalingConfigurationInfo :: ServerlessV2ScalingConfigurationInfo Source #

Create a value of ServerlessV2ScalingConfigurationInfo with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxCapacity:ServerlessV2ScalingConfigurationInfo', serverlessV2ScalingConfigurationInfo_maxCapacity - The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.

$sel:minCapacity:ServerlessV2ScalingConfigurationInfo', serverlessV2ScalingConfigurationInfo_minCapacity - The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

serverlessV2ScalingConfigurationInfo_maxCapacity :: Lens' ServerlessV2ScalingConfigurationInfo (Maybe Double) Source #

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.

serverlessV2ScalingConfigurationInfo_minCapacity :: Lens' ServerlessV2ScalingConfigurationInfo (Maybe Double) Source #

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

SourceRegion

data SourceRegion Source #

Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

See: newSourceRegion smart constructor.

Constructors

SourceRegion' 

Fields

Instances

Instances details
FromXML SourceRegion Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceRegion

Generic SourceRegion Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceRegion

Associated Types

type Rep SourceRegion :: Type -> Type #

Read SourceRegion Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceRegion

Show SourceRegion Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceRegion

NFData SourceRegion Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceRegion

Methods

rnf :: SourceRegion -> () #

Eq SourceRegion Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceRegion

Hashable SourceRegion Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceRegion

type Rep SourceRegion Source # 
Instance details

Defined in Amazonka.RDS.Types.SourceRegion

type Rep SourceRegion = D1 ('MetaData "SourceRegion" "Amazonka.RDS.Types.SourceRegion" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "SourceRegion'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "regionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "supportsDBInstanceAutomatedBackupsReplication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newSourceRegion :: SourceRegion Source #

Create a value of SourceRegion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpoint:SourceRegion', sourceRegion_endpoint - The endpoint for the source Amazon Web Services Region endpoint.

$sel:regionName:SourceRegion', sourceRegion_regionName - The name of the source Amazon Web Services Region.

$sel:status:SourceRegion', sourceRegion_status - The status of the source Amazon Web Services Region.

$sel:supportsDBInstanceAutomatedBackupsReplication:SourceRegion', sourceRegion_supportsDBInstanceAutomatedBackupsReplication - Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

sourceRegion_endpoint :: Lens' SourceRegion (Maybe Text) Source #

The endpoint for the source Amazon Web Services Region endpoint.

sourceRegion_regionName :: Lens' SourceRegion (Maybe Text) Source #

The name of the source Amazon Web Services Region.

sourceRegion_status :: Lens' SourceRegion (Maybe Text) Source #

The status of the source Amazon Web Services Region.

sourceRegion_supportsDBInstanceAutomatedBackupsReplication :: Lens' SourceRegion (Maybe Bool) Source #

Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

Subnet

data Subnet Source #

This data type is used as a response element for the DescribeDBSubnetGroups operation.

See: newSubnet smart constructor.

Constructors

Subnet' 

Fields

Instances

Instances details
FromXML Subnet Source # 
Instance details

Defined in Amazonka.RDS.Types.Subnet

Generic Subnet Source # 
Instance details

Defined in Amazonka.RDS.Types.Subnet

Associated Types

type Rep Subnet :: Type -> Type #

Methods

from :: Subnet -> Rep Subnet x #

to :: Rep Subnet x -> Subnet #

Read Subnet Source # 
Instance details

Defined in Amazonka.RDS.Types.Subnet

Show Subnet Source # 
Instance details

Defined in Amazonka.RDS.Types.Subnet

NFData Subnet Source # 
Instance details

Defined in Amazonka.RDS.Types.Subnet

Methods

rnf :: Subnet -> () #

Eq Subnet Source # 
Instance details

Defined in Amazonka.RDS.Types.Subnet

Methods

(==) :: Subnet -> Subnet -> Bool #

(/=) :: Subnet -> Subnet -> Bool #

Hashable Subnet Source # 
Instance details

Defined in Amazonka.RDS.Types.Subnet

Methods

hashWithSalt :: Int -> Subnet -> Int #

hash :: Subnet -> Int #

type Rep Subnet Source # 
Instance details

Defined in Amazonka.RDS.Types.Subnet

type Rep Subnet = D1 ('MetaData "Subnet" "Amazonka.RDS.Types.Subnet" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "Subnet'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "subnetAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AvailabilityZone)) :*: S1 ('MetaSel ('Just "subnetIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "subnetOutpost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Outpost)) :*: S1 ('MetaSel ('Just "subnetStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newSubnet :: Subnet Source #

Create a value of Subnet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:subnetAvailabilityZone:Subnet', subnet_subnetAvailabilityZone - Undocumented member.

$sel:subnetIdentifier:Subnet', subnet_subnetIdentifier - The identifier of the subnet.

$sel:subnetOutpost:Subnet', subnet_subnetOutpost - If the subnet is associated with an Outpost, this value specifies the Outpost.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

$sel:subnetStatus:Subnet', subnet_subnetStatus - The status of the subnet.

subnet_subnetIdentifier :: Lens' Subnet (Maybe Text) Source #

The identifier of the subnet.

subnet_subnetOutpost :: Lens' Subnet (Maybe Outpost) Source #

If the subnet is associated with an Outpost, this value specifies the Outpost.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

subnet_subnetStatus :: Lens' Subnet (Maybe Text) Source #

The status of the subnet.

SwitchoverDetail

data SwitchoverDetail Source #

Contains the details about a blue/green deployment.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

See: newSwitchoverDetail smart constructor.

Constructors

SwitchoverDetail' 

Fields

  • sourceMember :: Maybe Text

    The Amazon Resource Name (ARN) of a resource in the blue environment.

  • status :: Maybe Text

    The switchover status of a resource in a blue/green deployment.

    Values:

    • preparing-for-switchover - The resource is being prepared to switch over.
    • ready-for-switchover - The resource is ready to switch over.
    • switchover-in-progress - The resource is being switched over.
    • switchover-completed - The resource has been switched over.
    • switchover-failed - The resource attempted to switch over but failed.
  • targetMember :: Maybe Text

    The Amazon Resource Name (ARN) of a resource in the green environment.

Instances

Instances details
FromXML SwitchoverDetail Source # 
Instance details

Defined in Amazonka.RDS.Types.SwitchoverDetail

Generic SwitchoverDetail Source # 
Instance details

Defined in Amazonka.RDS.Types.SwitchoverDetail

Associated Types

type Rep SwitchoverDetail :: Type -> Type #

Read SwitchoverDetail Source # 
Instance details

Defined in Amazonka.RDS.Types.SwitchoverDetail

Show SwitchoverDetail Source # 
Instance details

Defined in Amazonka.RDS.Types.SwitchoverDetail

NFData SwitchoverDetail Source # 
Instance details

Defined in Amazonka.RDS.Types.SwitchoverDetail

Methods

rnf :: SwitchoverDetail -> () #

Eq SwitchoverDetail Source # 
Instance details

Defined in Amazonka.RDS.Types.SwitchoverDetail

Hashable SwitchoverDetail Source # 
Instance details

Defined in Amazonka.RDS.Types.SwitchoverDetail

type Rep SwitchoverDetail Source # 
Instance details

Defined in Amazonka.RDS.Types.SwitchoverDetail

type Rep SwitchoverDetail = D1 ('MetaData "SwitchoverDetail" "Amazonka.RDS.Types.SwitchoverDetail" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "SwitchoverDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourceMember") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "targetMember") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newSwitchoverDetail :: SwitchoverDetail Source #

Create a value of SwitchoverDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sourceMember:SwitchoverDetail', switchoverDetail_sourceMember - The Amazon Resource Name (ARN) of a resource in the blue environment.

$sel:status:SwitchoverDetail', switchoverDetail_status - The switchover status of a resource in a blue/green deployment.

Values:

  • preparing-for-switchover - The resource is being prepared to switch over.
  • ready-for-switchover - The resource is ready to switch over.
  • switchover-in-progress - The resource is being switched over.
  • switchover-completed - The resource has been switched over.
  • switchover-failed - The resource attempted to switch over but failed.

$sel:targetMember:SwitchoverDetail', switchoverDetail_targetMember - The Amazon Resource Name (ARN) of a resource in the green environment.

switchoverDetail_sourceMember :: Lens' SwitchoverDetail (Maybe Text) Source #

The Amazon Resource Name (ARN) of a resource in the blue environment.

switchoverDetail_status :: Lens' SwitchoverDetail (Maybe Text) Source #

The switchover status of a resource in a blue/green deployment.

Values:

  • preparing-for-switchover - The resource is being prepared to switch over.
  • ready-for-switchover - The resource is ready to switch over.
  • switchover-in-progress - The resource is being switched over.
  • switchover-completed - The resource has been switched over.
  • switchover-failed - The resource attempted to switch over but failed.

switchoverDetail_targetMember :: Lens' SwitchoverDetail (Maybe Text) Source #

The Amazon Resource Name (ARN) of a resource in the green environment.

Tag

data Tag Source #

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

See: newTag smart constructor.

Constructors

Tag' 

Fields

  • key :: Maybe Text

    A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't 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}_.:/=+\\-@]*)$").

  • value :: Maybe Text

    A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't 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}_.:/=+\\-@]*)$").

Instances

Instances details
ToQuery Tag Source # 
Instance details

Defined in Amazonka.RDS.Types.Tag

Methods

toQuery :: Tag -> QueryString #

FromXML Tag Source # 
Instance details

Defined in Amazonka.RDS.Types.Tag

Methods

parseXML :: [Node] -> Either String Tag #

Generic Tag Source # 
Instance details

Defined in Amazonka.RDS.Types.Tag

Associated Types

type Rep Tag :: Type -> Type #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

Read Tag Source # 
Instance details

Defined in Amazonka.RDS.Types.Tag

Show Tag Source # 
Instance details

Defined in Amazonka.RDS.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

NFData Tag Source # 
Instance details

Defined in Amazonka.RDS.Types.Tag

Methods

rnf :: Tag -> () #

Eq Tag Source # 
Instance details

Defined in Amazonka.RDS.Types.Tag

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Hashable Tag Source # 
Instance details

Defined in Amazonka.RDS.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

type Rep Tag Source # 
Instance details

Defined in Amazonka.RDS.Types.Tag

type Rep Tag = D1 ('MetaData "Tag" "Amazonka.RDS.Types.Tag" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newTag :: Tag Source #

Create a value of Tag with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:key:Tag', tag_key - A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

$sel:value:Tag', tag_value - A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

tag_key :: Lens' Tag (Maybe Text) Source #

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

tag_value :: Lens' Tag (Maybe Text) Source #

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

TargetHealth

data TargetHealth Source #

Information about the connection health of an RDS Proxy target.

See: newTargetHealth smart constructor.

Constructors

TargetHealth' 

Fields

  • description :: Maybe Text

    A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

  • reason :: Maybe TargetHealthReason

    The reason for the current health State of the RDS Proxy target.

  • state :: Maybe TargetState

    The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

    registering > unavailable > available > unavailable > available

Instances

Instances details
FromXML TargetHealth Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealth

Generic TargetHealth Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealth

Associated Types

type Rep TargetHealth :: Type -> Type #

Read TargetHealth Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealth

Show TargetHealth Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealth

NFData TargetHealth Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealth

Methods

rnf :: TargetHealth -> () #

Eq TargetHealth Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealth

Hashable TargetHealth Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealth

type Rep TargetHealth Source # 
Instance details

Defined in Amazonka.RDS.Types.TargetHealth

type Rep TargetHealth = D1 ('MetaData "TargetHealth" "Amazonka.RDS.Types.TargetHealth" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "TargetHealth'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetHealthReason)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetState)))))

newTargetHealth :: TargetHealth Source #

Create a value of TargetHealth with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:TargetHealth', targetHealth_description - A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

$sel:reason:TargetHealth', targetHealth_reason - The reason for the current health State of the RDS Proxy target.

$sel:state:TargetHealth', targetHealth_state - The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

registering > unavailable > available > unavailable > available

targetHealth_description :: Lens' TargetHealth (Maybe Text) Source #

A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

targetHealth_reason :: Lens' TargetHealth (Maybe TargetHealthReason) Source #

The reason for the current health State of the RDS Proxy target.

targetHealth_state :: Lens' TargetHealth (Maybe TargetState) Source #

The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

registering > unavailable > available > unavailable > available

Timezone

data Timezone Source #

A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.

See: newTimezone smart constructor.

Constructors

Timezone' 

Fields

Instances

Instances details
FromXML Timezone Source # 
Instance details

Defined in Amazonka.RDS.Types.Timezone

Generic Timezone Source # 
Instance details

Defined in Amazonka.RDS.Types.Timezone

Associated Types

type Rep Timezone :: Type -> Type #

Methods

from :: Timezone -> Rep Timezone x #

to :: Rep Timezone x -> Timezone #

Read Timezone Source # 
Instance details

Defined in Amazonka.RDS.Types.Timezone

Show Timezone Source # 
Instance details

Defined in Amazonka.RDS.Types.Timezone

NFData Timezone Source # 
Instance details

Defined in Amazonka.RDS.Types.Timezone

Methods

rnf :: Timezone -> () #

Eq Timezone Source # 
Instance details

Defined in Amazonka.RDS.Types.Timezone

Hashable Timezone Source # 
Instance details

Defined in Amazonka.RDS.Types.Timezone

Methods

hashWithSalt :: Int -> Timezone -> Int #

hash :: Timezone -> Int #

type Rep Timezone Source # 
Instance details

Defined in Amazonka.RDS.Types.Timezone

type Rep Timezone = D1 ('MetaData "Timezone" "Amazonka.RDS.Types.Timezone" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "Timezone'" 'PrefixI 'True) (S1 ('MetaSel ('Just "timezoneName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newTimezone :: Timezone Source #

Create a value of Timezone with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:timezoneName:Timezone', timezone_timezoneName - The name of the time zone.

timezone_timezoneName :: Lens' Timezone (Maybe Text) Source #

The name of the time zone.

UpgradeTarget

data UpgradeTarget Source #

The version of the database engine that a DB instance can be upgraded to.

See: newUpgradeTarget smart constructor.

Constructors

UpgradeTarget' 

Fields

Instances

Instances details
FromXML UpgradeTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.UpgradeTarget

Generic UpgradeTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.UpgradeTarget

Associated Types

type Rep UpgradeTarget :: Type -> Type #

Read UpgradeTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.UpgradeTarget

Show UpgradeTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.UpgradeTarget

NFData UpgradeTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.UpgradeTarget

Methods

rnf :: UpgradeTarget -> () #

Eq UpgradeTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.UpgradeTarget

Hashable UpgradeTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.UpgradeTarget

type Rep UpgradeTarget Source # 
Instance details

Defined in Amazonka.RDS.Types.UpgradeTarget

type Rep UpgradeTarget = D1 ('MetaData "UpgradeTarget" "Amazonka.RDS.Types.UpgradeTarget" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "UpgradeTarget'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "autoUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "isMajorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "supportedEngineModes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "supportsBabelfish") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "supportsGlobalDatabases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "supportsParallelQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))

newUpgradeTarget :: UpgradeTarget Source #

Create a value of UpgradeTarget with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:autoUpgrade:UpgradeTarget', upgradeTarget_autoUpgrade - A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

$sel:description:UpgradeTarget', upgradeTarget_description - The version of the database engine that a DB instance can be upgraded to.

$sel:engine:UpgradeTarget', upgradeTarget_engine - The name of the upgrade target database engine.

$sel:engineVersion:UpgradeTarget', upgradeTarget_engineVersion - The version number of the upgrade target database engine.

$sel:isMajorVersionUpgrade:UpgradeTarget', upgradeTarget_isMajorVersionUpgrade - A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.

$sel:supportedEngineModes:UpgradeTarget', upgradeTarget_supportedEngineModes - A list of the supported DB engine modes for the target engine version.

$sel:supportsBabelfish:UpgradeTarget', upgradeTarget_supportsBabelfish - A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

$sel:supportsGlobalDatabases:UpgradeTarget', upgradeTarget_supportsGlobalDatabases - A value that indicates whether you can use Aurora global databases with the target engine version.

$sel:supportsParallelQuery:UpgradeTarget', upgradeTarget_supportsParallelQuery - A value that indicates whether you can use Aurora parallel query with the target engine version.

upgradeTarget_autoUpgrade :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

upgradeTarget_description :: Lens' UpgradeTarget (Maybe Text) Source #

The version of the database engine that a DB instance can be upgraded to.

upgradeTarget_engine :: Lens' UpgradeTarget (Maybe Text) Source #

The name of the upgrade target database engine.

upgradeTarget_engineVersion :: Lens' UpgradeTarget (Maybe Text) Source #

The version number of the upgrade target database engine.

upgradeTarget_isMajorVersionUpgrade :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.

upgradeTarget_supportedEngineModes :: Lens' UpgradeTarget (Maybe [Text]) Source #

A list of the supported DB engine modes for the target engine version.

upgradeTarget_supportsBabelfish :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

upgradeTarget_supportsGlobalDatabases :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether you can use Aurora global databases with the target engine version.

upgradeTarget_supportsParallelQuery :: Lens' UpgradeTarget (Maybe Bool) Source #

A value that indicates whether you can use Aurora parallel query with the target engine version.

UserAuthConfig

data UserAuthConfig Source #

Specifies the details of authentication used by a proxy to log in as a specific database user.

See: newUserAuthConfig smart constructor.

Constructors

UserAuthConfig' 

Fields

  • authScheme :: Maybe AuthScheme

    The type of authentication that the proxy uses for connections from the proxy to the underlying database.

  • clientPasswordAuthType :: Maybe ClientPasswordAuthType

    The type of authentication the proxy uses for connections from clients.

  • description :: Maybe Text

    A user-specified description about the authentication used by a proxy to log in as a specific database user.

  • iAMAuth :: Maybe IAMAuthMode

    Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

  • secretArn :: Maybe Text

    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

  • userName :: Maybe Text

    The name of the database user to which the proxy connects.

Instances

Instances details
ToQuery UserAuthConfig Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfig

Generic UserAuthConfig Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfig

Associated Types

type Rep UserAuthConfig :: Type -> Type #

Read UserAuthConfig Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfig

Show UserAuthConfig Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfig

NFData UserAuthConfig Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfig

Methods

rnf :: UserAuthConfig -> () #

Eq UserAuthConfig Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfig

Hashable UserAuthConfig Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfig

type Rep UserAuthConfig Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfig

newUserAuthConfig :: UserAuthConfig Source #

Create a value of UserAuthConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authScheme:UserAuthConfig', userAuthConfig_authScheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database.

$sel:clientPasswordAuthType:UserAuthConfig', userAuthConfig_clientPasswordAuthType - The type of authentication the proxy uses for connections from clients.

$sel:description:UserAuthConfig', userAuthConfig_description - A user-specified description about the authentication used by a proxy to log in as a specific database user.

$sel:iAMAuth:UserAuthConfig', userAuthConfig_iAMAuth - Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

$sel:secretArn:UserAuthConfig', userAuthConfig_secretArn - The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

$sel:userName:UserAuthConfig', userAuthConfig_userName - The name of the database user to which the proxy connects.

userAuthConfig_authScheme :: Lens' UserAuthConfig (Maybe AuthScheme) Source #

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

userAuthConfig_clientPasswordAuthType :: Lens' UserAuthConfig (Maybe ClientPasswordAuthType) Source #

The type of authentication the proxy uses for connections from clients.

userAuthConfig_description :: Lens' UserAuthConfig (Maybe Text) Source #

A user-specified description about the authentication used by a proxy to log in as a specific database user.

userAuthConfig_iAMAuth :: Lens' UserAuthConfig (Maybe IAMAuthMode) Source #

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

userAuthConfig_secretArn :: Lens' UserAuthConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

userAuthConfig_userName :: Lens' UserAuthConfig (Maybe Text) Source #

The name of the database user to which the proxy connects.

UserAuthConfigInfo

data UserAuthConfigInfo Source #

Returns the details of authentication used by a proxy to log in as a specific database user.

See: newUserAuthConfigInfo smart constructor.

Constructors

UserAuthConfigInfo' 

Fields

  • authScheme :: Maybe AuthScheme

    The type of authentication that the proxy uses for connections from the proxy to the underlying database.

  • clientPasswordAuthType :: Maybe ClientPasswordAuthType

    The type of authentication the proxy uses for connections from clients.

  • description :: Maybe Text

    A user-specified description about the authentication used by a proxy to log in as a specific database user.

  • iAMAuth :: Maybe IAMAuthMode

    Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

  • secretArn :: Maybe Text

    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

  • userName :: Maybe Text

    The name of the database user to which the proxy connects.

Instances

Instances details
FromXML UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

Generic UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

Associated Types

type Rep UserAuthConfigInfo :: Type -> Type #

Read UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

Show UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

NFData UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

Methods

rnf :: UserAuthConfigInfo -> () #

Eq UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

Hashable UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

type Rep UserAuthConfigInfo Source # 
Instance details

Defined in Amazonka.RDS.Types.UserAuthConfigInfo

type Rep UserAuthConfigInfo = D1 ('MetaData "UserAuthConfigInfo" "Amazonka.RDS.Types.UserAuthConfigInfo" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "UserAuthConfigInfo'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthScheme)) :*: (S1 ('MetaSel ('Just "clientPasswordAuthType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientPasswordAuthType)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "iAMAuth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IAMAuthMode)) :*: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newUserAuthConfigInfo :: UserAuthConfigInfo Source #

Create a value of UserAuthConfigInfo with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authScheme:UserAuthConfigInfo', userAuthConfigInfo_authScheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database.

$sel:clientPasswordAuthType:UserAuthConfigInfo', userAuthConfigInfo_clientPasswordAuthType - The type of authentication the proxy uses for connections from clients.

$sel:description:UserAuthConfigInfo', userAuthConfigInfo_description - A user-specified description about the authentication used by a proxy to log in as a specific database user.

$sel:iAMAuth:UserAuthConfigInfo', userAuthConfigInfo_iAMAuth - Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

$sel:secretArn:UserAuthConfigInfo', userAuthConfigInfo_secretArn - The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

$sel:userName:UserAuthConfigInfo', userAuthConfigInfo_userName - The name of the database user to which the proxy connects.

userAuthConfigInfo_authScheme :: Lens' UserAuthConfigInfo (Maybe AuthScheme) Source #

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

userAuthConfigInfo_clientPasswordAuthType :: Lens' UserAuthConfigInfo (Maybe ClientPasswordAuthType) Source #

The type of authentication the proxy uses for connections from clients.

userAuthConfigInfo_description :: Lens' UserAuthConfigInfo (Maybe Text) Source #

A user-specified description about the authentication used by a proxy to log in as a specific database user.

userAuthConfigInfo_iAMAuth :: Lens' UserAuthConfigInfo (Maybe IAMAuthMode) Source #

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

userAuthConfigInfo_secretArn :: Lens' UserAuthConfigInfo (Maybe Text) Source #

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

userAuthConfigInfo_userName :: Lens' UserAuthConfigInfo (Maybe Text) Source #

The name of the database user to which the proxy connects.

ValidDBInstanceModificationsMessage

data ValidDBInstanceModificationsMessage Source #

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

See: newValidDBInstanceModificationsMessage smart constructor.

Constructors

ValidDBInstanceModificationsMessage' 

Fields

Instances

Instances details
FromXML ValidDBInstanceModificationsMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidDBInstanceModificationsMessage

Generic ValidDBInstanceModificationsMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidDBInstanceModificationsMessage

Read ValidDBInstanceModificationsMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidDBInstanceModificationsMessage

Show ValidDBInstanceModificationsMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidDBInstanceModificationsMessage

NFData ValidDBInstanceModificationsMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidDBInstanceModificationsMessage

Eq ValidDBInstanceModificationsMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidDBInstanceModificationsMessage

Hashable ValidDBInstanceModificationsMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidDBInstanceModificationsMessage

type Rep ValidDBInstanceModificationsMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidDBInstanceModificationsMessage

type Rep ValidDBInstanceModificationsMessage = D1 ('MetaData "ValidDBInstanceModificationsMessage" "Amazonka.RDS.Types.ValidDBInstanceModificationsMessage" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ValidDBInstanceModificationsMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "storage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ValidStorageOptions])) :*: S1 ('MetaSel ('Just "validProcessorFeatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AvailableProcessorFeature]))))

newValidDBInstanceModificationsMessage :: ValidDBInstanceModificationsMessage Source #

Create a value of ValidDBInstanceModificationsMessage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:storage:ValidDBInstanceModificationsMessage', validDBInstanceModificationsMessage_storage - Valid storage options for your DB instance.

$sel:validProcessorFeatures:ValidDBInstanceModificationsMessage', validDBInstanceModificationsMessage_validProcessorFeatures - Valid processor features for your DB instance.

ValidStorageOptions

data ValidStorageOptions Source #

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

See: newValidStorageOptions smart constructor.

Constructors

ValidStorageOptions' 

Fields

Instances

Instances details
FromXML ValidStorageOptions Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidStorageOptions

Generic ValidStorageOptions Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidStorageOptions

Associated Types

type Rep ValidStorageOptions :: Type -> Type #

Read ValidStorageOptions Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidStorageOptions

Show ValidStorageOptions Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidStorageOptions

NFData ValidStorageOptions Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidStorageOptions

Methods

rnf :: ValidStorageOptions -> () #

Eq ValidStorageOptions Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidStorageOptions

Hashable ValidStorageOptions Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidStorageOptions

type Rep ValidStorageOptions Source # 
Instance details

Defined in Amazonka.RDS.Types.ValidStorageOptions

type Rep ValidStorageOptions = D1 ('MetaData "ValidStorageOptions" "Amazonka.RDS.Types.ValidStorageOptions" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ValidStorageOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "iopsToStorageRatio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DoubleRange])) :*: (S1 ('MetaSel ('Just "provisionedIops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Range])) :*: S1 ('MetaSel ('Just "provisionedStorageThroughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Range])))) :*: ((S1 ('MetaSel ('Just "storageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Range])) :*: S1 ('MetaSel ('Just "storageThroughputToIopsRatio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DoubleRange]))) :*: (S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "supportsStorageAutoscaling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

newValidStorageOptions :: ValidStorageOptions Source #

Create a value of ValidStorageOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:iopsToStorageRatio:ValidStorageOptions', validStorageOptions_iopsToStorageRatio - The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

$sel:provisionedIops:ValidStorageOptions', validStorageOptions_provisionedIops - The valid range of provisioned IOPS. For example, 1000-256,000.

$sel:provisionedStorageThroughput:ValidStorageOptions', validStorageOptions_provisionedStorageThroughput - The valid range of provisioned storage throughput. For example, 500-4,000 mebibytes per second (MiBps).

$sel:storageSize:ValidStorageOptions', validStorageOptions_storageSize - The valid range of storage in gibibytes (GiB). For example, 100 to 16,384.

$sel:storageThroughputToIopsRatio:ValidStorageOptions', validStorageOptions_storageThroughputToIopsRatio - The valid range of storage throughput to provisioned IOPS ratios. For example, 0-0.25.

$sel:storageType:ValidStorageOptions', validStorageOptions_storageType - The valid storage types for your DB instance. For example: gp2, gp3, io1.

$sel:supportsStorageAutoscaling:ValidStorageOptions', validStorageOptions_supportsStorageAutoscaling - Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

validStorageOptions_iopsToStorageRatio :: Lens' ValidStorageOptions (Maybe [DoubleRange]) Source #

The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

validStorageOptions_provisionedIops :: Lens' ValidStorageOptions (Maybe [Range]) Source #

The valid range of provisioned IOPS. For example, 1000-256,000.

validStorageOptions_provisionedStorageThroughput :: Lens' ValidStorageOptions (Maybe [Range]) Source #

The valid range of provisioned storage throughput. For example, 500-4,000 mebibytes per second (MiBps).

validStorageOptions_storageSize :: Lens' ValidStorageOptions (Maybe [Range]) Source #

The valid range of storage in gibibytes (GiB). For example, 100 to 16,384.

validStorageOptions_storageThroughputToIopsRatio :: Lens' ValidStorageOptions (Maybe [DoubleRange]) Source #

The valid range of storage throughput to provisioned IOPS ratios. For example, 0-0.25.

validStorageOptions_storageType :: Lens' ValidStorageOptions (Maybe Text) Source #

The valid storage types for your DB instance. For example: gp2, gp3, io1.

validStorageOptions_supportsStorageAutoscaling :: Lens' ValidStorageOptions (Maybe Bool) Source #

Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

VpcSecurityGroupMembership

data VpcSecurityGroupMembership Source #

This data type is used as a response element for queries on VPC security group membership.

See: newVpcSecurityGroupMembership smart constructor.

Constructors

VpcSecurityGroupMembership' 

Fields

Instances

Instances details
FromXML VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.VpcSecurityGroupMembership

Generic VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.VpcSecurityGroupMembership

Associated Types

type Rep VpcSecurityGroupMembership :: Type -> Type #

Read VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.VpcSecurityGroupMembership

Show VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.VpcSecurityGroupMembership

NFData VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.VpcSecurityGroupMembership

Eq VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.VpcSecurityGroupMembership

Hashable VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.VpcSecurityGroupMembership

type Rep VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.RDS.Types.VpcSecurityGroupMembership

type Rep VpcSecurityGroupMembership = D1 ('MetaData "VpcSecurityGroupMembership" "Amazonka.RDS.Types.VpcSecurityGroupMembership" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "VpcSecurityGroupMembership'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcSecurityGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newVpcSecurityGroupMembership :: VpcSecurityGroupMembership Source #

Create a value of VpcSecurityGroupMembership with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:VpcSecurityGroupMembership', vpcSecurityGroupMembership_status - The membership status of the VPC security group.

Currently, the only valid status is active.

$sel:vpcSecurityGroupId:VpcSecurityGroupMembership', vpcSecurityGroupMembership_vpcSecurityGroupId - The name of the VPC security group.

vpcSecurityGroupMembership_status :: Lens' VpcSecurityGroupMembership (Maybe Text) Source #

The membership status of the VPC security group.

Currently, the only valid status is active.