amazonka-docdb-2.0: Amazon DocumentDB with MongoDB compatibility 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.DocumentDB

Contents

Description

Derived from API version 2014-10-31 of the AWS service descriptions, licensed under Apache 2.0.

Amazon DocumentDB API documentation

Synopsis

Service Configuration

defaultService :: Service Source #

API version 2014-10-31 of the Amazon DocumentDB with MongoDB compatibility SDK configuration.

Errors

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

AuthorizationNotFoundFault

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

The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.

Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.

CertificateNotFoundFault

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

CertificateIdentifier doesn't refer to an existing certificate.

DBClusterAlreadyExistsFault

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

You already have a cluster with the given identifier.

DBClusterNotFoundFault

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

DBClusterIdentifier doesn't refer to an existing cluster.

DBClusterParameterGroupNotFoundFault

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

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

DBClusterQuotaExceededFault

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

The cluster can't be created because you have reached the maximum allowed quota of clusters.

DBClusterSnapshotAlreadyExistsFault

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

You already have a cluster snapshot with the given identifier.

DBClusterSnapshotNotFoundFault

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

DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

DBInstanceAlreadyExistsFault

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

You already have a instance with the given identifier.

DBInstanceNotFoundFault

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

DBInstanceIdentifier doesn't refer to an existing instance.

DBParameterGroupAlreadyExistsFault

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

A parameter group with the same name already exists.

DBParameterGroupNotFoundFault

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

DBParameterGroupName doesn't refer to an existing parameter group.

DBParameterGroupQuotaExceededFault

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

This request would cause you to exceed the allowed number of parameter groups.

DBSecurityGroupNotFoundFault

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

DBSecurityGroupName doesn't refer to an existing security group.

DBSnapshotAlreadyExistsFault

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

DBSnapshotIdentifier is already being used by an existing snapshot.

DBSnapshotNotFoundFault

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

DBSnapshotIdentifier doesn't refer to an existing snapshot.

DBSubnetGroupAlreadyExistsFault

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

DBSubnetGroupName is already being used by an existing subnet group.

DBSubnetGroupDoesNotCoverEnoughAZs

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

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

DBSubnetGroupNotFoundFault

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

DBSubnetGroupName doesn't refer to an existing subnet group.

DBSubnetGroupQuotaExceededFault

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

The request would cause you to exceed the allowed number of subnet groups.

DBSubnetQuotaExceededFault

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

The request would cause you to exceed the allowed number of subnets in a subnet group.

DBUpgradeDependencyFailureFault

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

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

EventSubscriptionQuotaExceededFault

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

You have reached the maximum number of event subscriptions.

GlobalClusterAlreadyExistsFault

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

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

GlobalClusterNotFoundFault

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

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

GlobalClusterQuotaExceededFault

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

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

InstanceQuotaExceededFault

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

The request would cause you to exceed the allowed number of instances.

InsufficientDBClusterCapacityFault

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

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

InsufficientDBInstanceCapacityFault

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

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

InsufficientStorageClusterCapacityFault

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

There is not enough 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.

InvalidDBClusterSnapshotStateFault

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

The provided value isn't a valid cluster snapshot state.

InvalidDBClusterStateFault

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

The cluster isn't in a valid state.

InvalidDBInstanceStateFault

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

The specified instance isn't in the available state.

InvalidDBParameterGroupStateFault

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

The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

InvalidDBSecurityGroupStateFault

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

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

InvalidDBSnapshotStateFault

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

The state of the snapshot doesn't allow deletion.

InvalidDBSubnetGroupStateFault

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

The subnet group can't be deleted because it's in use.

InvalidDBSubnetStateFault

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

The subnet isn't in the available state.

InvalidEventSubscriptionStateFault

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

Someone else might be modifying a subscription. Wait a few seconds, and try again.

InvalidGlobalClusterStateFault

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

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

InvalidRestoreFault

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

You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.

InvalidSubnet

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

The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

InvalidVPCNetworkStateFault

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

The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

KMSKeyNotAccessibleFault

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

An error occurred when accessing an KMS key.

ResourceNotFoundFault

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

The specified resource ID was not found.

SNSInvalidTopicFault

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

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

SNSNoAuthorizationFault

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

You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).

SNSTopicArnNotFoundFault

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

The SNS topic Amazon Resource Name (ARN) does not exist.

SharedSnapshotQuotaExceededFault

_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

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

The request would cause you to exceed the allowed number of snapshots.

SourceNotFoundFault

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

The requested source could not be found.

StorageQuotaExceededFault

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

The request would cause you to exceed the allowed amount of storage available across all instances.

StorageTypeNotSupportedFault

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

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

SubnetAlreadyInUse

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

The subnet is already in use in the Availability Zone.

SubscriptionAlreadyExistFault

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

The provided subscription name already exists.

SubscriptionCategoryNotFoundFault

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

The provided category does not exist.

SubscriptionNotFoundFault

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

The subscription name does not exist.

Waiters

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

DBInstanceAvailable

newDBInstanceAvailable :: Wait DescribeDBInstances Source #

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

DBInstanceDeleted

newDBInstanceDeleted :: Wait DescribeDBInstances Source #

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

Operations

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

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

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

AddSourceIdentifierToSubscription

data AddSourceIdentifierToSubscription Source #

Represents the input to AddSourceIdentifierToSubscription.

See: newAddSourceIdentifierToSubscription smart constructor.

Instances

Instances details
ToHeaders AddSourceIdentifierToSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

ToPath AddSourceIdentifierToSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

ToQuery AddSourceIdentifierToSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

AWSRequest AddSourceIdentifierToSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

Generic AddSourceIdentifierToSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

Associated Types

type Rep AddSourceIdentifierToSubscription :: Type -> Type #

Read AddSourceIdentifierToSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

Show AddSourceIdentifierToSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

NFData AddSourceIdentifierToSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

Eq AddSourceIdentifierToSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

Hashable AddSourceIdentifierToSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

type AWSResponse AddSourceIdentifierToSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

type Rep AddSourceIdentifierToSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

type Rep AddSourceIdentifierToSubscription = D1 ('MetaData "AddSourceIdentifierToSubscription" "Amazonka.DocumentDB.AddSourceIdentifierToSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "AddSourceIdentifierToSubscription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subscriptionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAddSourceIdentifierToSubscription Source #

Create a value of AddSourceIdentifierToSubscription 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:subscriptionName:AddSourceIdentifierToSubscription', addSourceIdentifierToSubscription_subscriptionName - The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to.

AddSourceIdentifierToSubscription, addSourceIdentifierToSubscription_sourceIdentifier - The identifier of the event source to be added:

  • If the source type is an instance, a DBInstanceIdentifier must be provided.
  • If the source type is a security group, a DBSecurityGroupName must be provided.
  • If the source type is a parameter group, a DBParameterGroupName must be provided.
  • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

data AddSourceIdentifierToSubscriptionResponse Source #

Instances

Instances details
Generic AddSourceIdentifierToSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

Read AddSourceIdentifierToSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

Show AddSourceIdentifierToSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

NFData AddSourceIdentifierToSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

Eq AddSourceIdentifierToSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

type Rep AddSourceIdentifierToSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.AddSourceIdentifierToSubscription

type Rep AddSourceIdentifierToSubscriptionResponse = D1 ('MetaData "AddSourceIdentifierToSubscriptionResponse" "Amazonka.DocumentDB.AddSourceIdentifierToSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "AddSourceIdentifierToSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

AddTagsToResource

data AddTagsToResource Source #

Represents the input to AddTagsToResource.

See: newAddTagsToResource smart constructor.

Constructors

AddTagsToResource' Text [Tag] 

Instances

Instances details
ToHeaders AddTagsToResource Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

ToPath AddTagsToResource Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

ToQuery AddTagsToResource Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

AWSRequest AddTagsToResource Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

Associated Types

type AWSResponse AddTagsToResource #

Generic AddTagsToResource Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

Associated Types

type Rep AddTagsToResource :: Type -> Type #

Read AddTagsToResource Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

Show AddTagsToResource Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

NFData AddTagsToResource Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

Methods

rnf :: AddTagsToResource -> () #

Eq AddTagsToResource Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

Hashable AddTagsToResource Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

type AWSResponse AddTagsToResource Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

type Rep AddTagsToResource Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

type Rep AddTagsToResource = D1 ('MetaData "AddTagsToResource" "Amazonka.DocumentDB.AddTagsToResource" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "AddTagsToResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag])))

newAddTagsToResource Source #

Create a value of AddTagsToResource 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:resourceName:AddTagsToResource', addTagsToResource_resourceName - The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .

$sel:tags:AddTagsToResource', addTagsToResource_tags - The tags to be assigned to the Amazon DocumentDB resource.

data AddTagsToResourceResponse Source #

See: newAddTagsToResourceResponse smart constructor.

Instances

Instances details
Generic AddTagsToResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

Associated Types

type Rep AddTagsToResourceResponse :: Type -> Type #

Read AddTagsToResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

Show AddTagsToResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

NFData AddTagsToResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

Eq AddTagsToResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

type Rep AddTagsToResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.AddTagsToResource

type Rep AddTagsToResourceResponse = D1 ('MetaData "AddTagsToResourceResponse" "Amazonka.DocumentDB.AddTagsToResource" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "AddTagsToResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAddTagsToResourceResponse :: AddTagsToResourceResponse Source #

Create a value of AddTagsToResourceResponse with all optional fields omitted.

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

ApplyPendingMaintenanceAction

data ApplyPendingMaintenanceAction Source #

Represents the input to ApplyPendingMaintenanceAction.

See: newApplyPendingMaintenanceAction smart constructor.

Instances

Instances details
ToHeaders ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

ToPath ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

ToQuery ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

AWSRequest ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Generic ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Associated Types

type Rep ApplyPendingMaintenanceAction :: Type -> Type #

Read ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Show ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

NFData ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Eq ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Hashable ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

type AWSResponse ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

type Rep ApplyPendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

type Rep ApplyPendingMaintenanceAction = D1 ('MetaData "ApplyPendingMaintenanceAction" "Amazonka.DocumentDB.ApplyPendingMaintenanceAction" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ApplyPendingMaintenanceAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "applyAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "optInType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newApplyPendingMaintenanceAction Source #

Create a value of ApplyPendingMaintenanceAction 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:

ApplyPendingMaintenanceAction, applyPendingMaintenanceAction_resourceIdentifier - The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

$sel:applyAction:ApplyPendingMaintenanceAction', applyPendingMaintenanceAction_applyAction - The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

$sel:optInType:ApplyPendingMaintenanceAction', applyPendingMaintenanceAction_optInType - A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone.

Valid values:

  • immediate - Apply the maintenance action immediately.
  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

data ApplyPendingMaintenanceActionResponse Source #

Instances

Instances details
Generic ApplyPendingMaintenanceActionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Read ApplyPendingMaintenanceActionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Show ApplyPendingMaintenanceActionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

NFData ApplyPendingMaintenanceActionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

Eq ApplyPendingMaintenanceActionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

type Rep ApplyPendingMaintenanceActionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ApplyPendingMaintenanceAction

type Rep ApplyPendingMaintenanceActionResponse = D1 ('MetaData "ApplyPendingMaintenanceActionResponse" "Amazonka.DocumentDB.ApplyPendingMaintenanceAction" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ApplyPendingMaintenanceActionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourcePendingMaintenanceActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourcePendingMaintenanceActions)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

CopyDBClusterParameterGroup

data CopyDBClusterParameterGroup Source #

Represents the input to CopyDBClusterParameterGroup.

See: newCopyDBClusterParameterGroup smart constructor.

Instances

Instances details
ToHeaders CopyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

ToPath CopyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

ToQuery CopyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

AWSRequest CopyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

Generic CopyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

Associated Types

type Rep CopyDBClusterParameterGroup :: Type -> Type #

Read CopyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

Show CopyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

NFData CopyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

Eq CopyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

Hashable CopyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

type AWSResponse CopyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

type Rep CopyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

type Rep CopyDBClusterParameterGroup = D1 ('MetaData "CopyDBClusterParameterGroup" "Amazonka.DocumentDB.CopyDBClusterParameterGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CopyDBClusterParameterGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "sourceDBClusterParameterGroupIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "targetDBClusterParameterGroupIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "targetDBClusterParameterGroupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCopyDBClusterParameterGroup Source #

Create a value of CopyDBClusterParameterGroup 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:tags:CopyDBClusterParameterGroup', copyDBClusterParameterGroup_tags - The tags that are to be assigned to the parameter group.

$sel:sourceDBClusterParameterGroupIdentifier:CopyDBClusterParameterGroup', copyDBClusterParameterGroup_sourceDBClusterParameterGroupIdentifier - The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.

Constraints:

  • Must specify a valid cluster parameter group.
  • If the source cluster parameter group is in the same Amazon Web Services Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.
  • If the source parameter group is in a different Amazon Web Services Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.

$sel:targetDBClusterParameterGroupIdentifier:CopyDBClusterParameterGroup', copyDBClusterParameterGroup_targetDBClusterParameterGroupIdentifier - The identifier for the copied cluster parameter group.

Constraints:

  • Cannot be null, empty, or blank.
  • Must contain from 1 to 255 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-param-group1

$sel:targetDBClusterParameterGroupDescription:CopyDBClusterParameterGroup', copyDBClusterParameterGroup_targetDBClusterParameterGroupDescription - A description for the copied cluster parameter group.

data CopyDBClusterParameterGroupResponse Source #

Instances

Instances details
Generic CopyDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

Read CopyDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

Show CopyDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

NFData CopyDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

Eq CopyDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

type Rep CopyDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterParameterGroup

type Rep CopyDBClusterParameterGroupResponse = D1 ('MetaData "CopyDBClusterParameterGroupResponse" "Amazonka.DocumentDB.CopyDBClusterParameterGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CopyDBClusterParameterGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterParameterGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCopyDBClusterParameterGroupResponse Source #

Create a value of CopyDBClusterParameterGroupResponse 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:

CopyDBClusterParameterGroupResponse, copyDBClusterParameterGroupResponse_dbClusterParameterGroup - Undocumented member.

$sel:httpStatus:CopyDBClusterParameterGroupResponse', copyDBClusterParameterGroupResponse_httpStatus - The response's http status code.

CopyDBClusterSnapshot

data CopyDBClusterSnapshot Source #

Represents the input to CopyDBClusterSnapshot.

See: newCopyDBClusterSnapshot smart constructor.

Instances

Instances details
ToHeaders CopyDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

ToPath CopyDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

ToQuery CopyDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

AWSRequest CopyDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

Associated Types

type AWSResponse CopyDBClusterSnapshot #

Generic CopyDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

Associated Types

type Rep CopyDBClusterSnapshot :: Type -> Type #

Read CopyDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

Show CopyDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

NFData CopyDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

Methods

rnf :: CopyDBClusterSnapshot -> () #

Eq CopyDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

Hashable CopyDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

type AWSResponse CopyDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

type Rep CopyDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

type Rep CopyDBClusterSnapshot = D1 ('MetaData "CopyDBClusterSnapshot" "Amazonka.DocumentDB.CopyDBClusterSnapshot" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CopyDBClusterSnapshot'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "copyTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "preSignedUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "sourceDBClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "targetDBClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCopyDBClusterSnapshot Source #

Create a value of CopyDBClusterSnapshot 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:copyTags:CopyDBClusterSnapshot', copyDBClusterSnapshot_copyTags - Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.

CopyDBClusterSnapshot, copyDBClusterSnapshot_kmsKeyId - The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Amazon Web Services Region that they are created in, and you can't use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

$sel:preSignedUrl:CopyDBClusterSnapshot', copyDBClusterSnapshot_preSignedUrl - The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.
  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

$sel:tags:CopyDBClusterSnapshot', copyDBClusterSnapshot_tags - The tags to be assigned to the cluster snapshot.

$sel:sourceDBClusterSnapshotIdentifier:CopyDBClusterSnapshot', copyDBClusterSnapshot_sourceDBClusterSnapshotIdentifier - The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid system snapshot in the available state.
  • If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot identifier.
  • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

$sel:targetDBClusterSnapshotIdentifier:CopyDBClusterSnapshot', copyDBClusterSnapshot_targetDBClusterSnapshotIdentifier - The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

data CopyDBClusterSnapshotResponse Source #

See: newCopyDBClusterSnapshotResponse smart constructor.

Instances

Instances details
Generic CopyDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

Associated Types

type Rep CopyDBClusterSnapshotResponse :: Type -> Type #

Read CopyDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

Show CopyDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

NFData CopyDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

Eq CopyDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

type Rep CopyDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CopyDBClusterSnapshot

type Rep CopyDBClusterSnapshotResponse = D1 ('MetaData "CopyDBClusterSnapshotResponse" "Amazonka.DocumentDB.CopyDBClusterSnapshot" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CopyDBClusterSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterSnapshot)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCopyDBClusterSnapshotResponse Source #

Create a value of CopyDBClusterSnapshotResponse 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:dbClusterSnapshot:CopyDBClusterSnapshotResponse', copyDBClusterSnapshotResponse_dbClusterSnapshot - Undocumented member.

$sel:httpStatus:CopyDBClusterSnapshotResponse', copyDBClusterSnapshotResponse_httpStatus - The response's http status code.

CreateDBCluster

data CreateDBCluster Source #

Represents the input to CreateDBCluster.

See: newCreateDBCluster smart constructor.

Instances

Instances details
ToHeaders CreateDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

ToPath CreateDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

ToQuery CreateDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

AWSRequest CreateDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

Associated Types

type AWSResponse CreateDBCluster #

Generic CreateDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

Associated Types

type Rep CreateDBCluster :: Type -> Type #

Read CreateDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

Show CreateDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

NFData CreateDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

Methods

rnf :: CreateDBCluster -> () #

Eq CreateDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

Hashable CreateDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

type AWSResponse CreateDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

type Rep CreateDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

type Rep CreateDBCluster = D1 ('MetaData "CreateDBCluster" "Amazonka.DocumentDB.CreateDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateDBCluster'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "enableCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "masterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "preSignedUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newCreateDBCluster Source #

Create a value of CreateDBCluster 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:

CreateDBCluster, createDBCluster_availabilityZones - A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

CreateDBCluster, createDBCluster_backupRetentionPeriod - The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35.

CreateDBCluster, createDBCluster_dbClusterParameterGroupName - The name of the cluster parameter group to associate with this cluster.

CreateDBCluster, createDBCluster_dbSubnetGroupName - A subnet group to associate with this cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

CreateDBCluster, createDBCluster_deletionProtection - Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

$sel:enableCloudwatchLogsExports:CreateDBCluster', createDBCluster_enableCloudwatchLogsExports - A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

CreateDBCluster, createDBCluster_engineVersion - The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

CreateDBCluster, createDBCluster_globalClusterIdentifier - The cluster identifier of the new global cluster.

CreateDBCluster, createDBCluster_kmsKeyId - The KMS key identifier for an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

  • If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.

CreateDBCluster, createDBCluster_masterUserPassword - The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

CreateDBCluster, createDBCluster_masterUsername - The name of the master user for the cluster.

Constraints:

  • Must be from 1 to 63 letters or numbers.
  • The first character must be a letter.
  • Cannot be a reserved word for the chosen database engine.

CreateDBCluster, createDBCluster_port - The port number on which the instances in the cluster accept connections.

$sel:preSignedUrl:CreateDBCluster', createDBCluster_preSignedUrl - Not currently supported.

CreateDBCluster, createDBCluster_preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

CreateDBCluster, createDBCluster_preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

CreateDBCluster, createDBCluster_storageEncrypted - Specifies whether the cluster is encrypted.

$sel:tags:CreateDBCluster', createDBCluster_tags - The tags to be assigned to the cluster.

$sel:vpcSecurityGroupIds:CreateDBCluster', createDBCluster_vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this cluster.

CreateDBCluster, createDBCluster_dbClusterIdentifier - The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

CreateDBCluster, createDBCluster_engine - The name of the database engine to be used for this cluster.

Valid values: docdb

data CreateDBClusterResponse Source #

See: newCreateDBClusterResponse smart constructor.

Instances

Instances details
Generic CreateDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

Associated Types

type Rep CreateDBClusterResponse :: Type -> Type #

Read CreateDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

Show CreateDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

NFData CreateDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

Methods

rnf :: CreateDBClusterResponse -> () #

Eq CreateDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

type Rep CreateDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBCluster

type Rep CreateDBClusterResponse = D1 ('MetaData "CreateDBClusterResponse" "Amazonka.DocumentDB.CreateDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateDBClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDBClusterResponse Source #

Create a value of CreateDBClusterResponse 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:dbCluster:CreateDBClusterResponse', createDBClusterResponse_dbCluster - Undocumented member.

$sel:httpStatus:CreateDBClusterResponse', createDBClusterResponse_httpStatus - The response's http status code.

CreateDBClusterParameterGroup

data CreateDBClusterParameterGroup Source #

Represents the input of CreateDBClusterParameterGroup.

See: newCreateDBClusterParameterGroup smart constructor.

Instances

Instances details
ToHeaders CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

ToPath CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

ToQuery CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

AWSRequest CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

Generic CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

Associated Types

type Rep CreateDBClusterParameterGroup :: Type -> Type #

Read CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

Show CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

NFData CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

Eq CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

Hashable CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

type AWSResponse CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

type Rep CreateDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

type Rep CreateDBClusterParameterGroup = D1 ('MetaData "CreateDBClusterParameterGroup" "Amazonka.DocumentDB.CreateDBClusterParameterGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateDBClusterParameterGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateDBClusterParameterGroup Source #

Create a value of CreateDBClusterParameterGroup 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:tags:CreateDBClusterParameterGroup', createDBClusterParameterGroup_tags - The tags to be assigned to the cluster parameter group.

CreateDBClusterParameterGroup, createDBClusterParameterGroup_dbClusterParameterGroupName - The name of the cluster parameter group.

Constraints:

  • Must not match the name of an existing DBClusterParameterGroup.

This value is stored as a lowercase string.

CreateDBClusterParameterGroup, createDBClusterParameterGroup_dbParameterGroupFamily - The cluster parameter group family name.

CreateDBClusterParameterGroup, createDBClusterParameterGroup_description - The description for the cluster parameter group.

data CreateDBClusterParameterGroupResponse Source #

Instances

Instances details
Generic CreateDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

Read CreateDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

Show CreateDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

NFData CreateDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

Eq CreateDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

type Rep CreateDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterParameterGroup

type Rep CreateDBClusterParameterGroupResponse = D1 ('MetaData "CreateDBClusterParameterGroupResponse" "Amazonka.DocumentDB.CreateDBClusterParameterGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateDBClusterParameterGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterParameterGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDBClusterParameterGroupResponse Source #

Create a value of CreateDBClusterParameterGroupResponse 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:

CreateDBClusterParameterGroupResponse, createDBClusterParameterGroupResponse_dbClusterParameterGroup - Undocumented member.

$sel:httpStatus:CreateDBClusterParameterGroupResponse', createDBClusterParameterGroupResponse_httpStatus - The response's http status code.

CreateDBClusterSnapshot

data CreateDBClusterSnapshot Source #

Represents the input of CreateDBClusterSnapshot.

See: newCreateDBClusterSnapshot smart constructor.

Instances

Instances details
ToHeaders CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

ToPath CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

ToQuery CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

AWSRequest CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Generic CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Associated Types

type Rep CreateDBClusterSnapshot :: Type -> Type #

Read CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Show CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

NFData CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Methods

rnf :: CreateDBClusterSnapshot -> () #

Eq CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Hashable CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

type AWSResponse CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

type Rep CreateDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

type Rep CreateDBClusterSnapshot = D1 ('MetaData "CreateDBClusterSnapshot" "Amazonka.DocumentDB.CreateDBClusterSnapshot" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateDBClusterSnapshot'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateDBClusterSnapshot Source #

Create a value of CreateDBClusterSnapshot 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:tags:CreateDBClusterSnapshot', createDBClusterSnapshot_tags - The tags to be assigned to the cluster snapshot.

CreateDBClusterSnapshot, createDBClusterSnapshot_dbClusterSnapshotIdentifier - The identifier of the cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot1

CreateDBClusterSnapshot, createDBClusterSnapshot_dbClusterIdentifier - The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Example: my-cluster

data CreateDBClusterSnapshotResponse Source #

See: newCreateDBClusterSnapshotResponse smart constructor.

Instances

Instances details
Generic CreateDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Associated Types

type Rep CreateDBClusterSnapshotResponse :: Type -> Type #

Read CreateDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Show CreateDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

NFData CreateDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

Eq CreateDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

type Rep CreateDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBClusterSnapshot

type Rep CreateDBClusterSnapshotResponse = D1 ('MetaData "CreateDBClusterSnapshotResponse" "Amazonka.DocumentDB.CreateDBClusterSnapshot" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateDBClusterSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterSnapshot)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDBClusterSnapshotResponse Source #

Create a value of CreateDBClusterSnapshotResponse 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:dbClusterSnapshot:CreateDBClusterSnapshotResponse', createDBClusterSnapshotResponse_dbClusterSnapshot - Undocumented member.

$sel:httpStatus:CreateDBClusterSnapshotResponse', createDBClusterSnapshotResponse_httpStatus - The response's http status code.

CreateDBInstance

data CreateDBInstance Source #

Represents the input to CreateDBInstance.

See: newCreateDBInstance smart constructor.

Instances

Instances details
ToHeaders CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

ToPath CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

ToQuery CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

AWSRequest CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Associated Types

type AWSResponse CreateDBInstance #

Generic CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Associated Types

type Rep CreateDBInstance :: Type -> Type #

Read CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Show CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

NFData CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Methods

rnf :: CreateDBInstance -> () #

Eq CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Hashable CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

type AWSResponse CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

type Rep CreateDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

type Rep CreateDBInstance = D1 ('MetaData "CreateDBInstance" "Amazonka.DocumentDB.CreateDBInstance" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateDBInstance'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "enablePerformanceInsights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "performanceInsightsKMSKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "promotionTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateDBInstance Source #

Create a value of CreateDBInstance 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:

CreateDBInstance, createDBInstance_autoMinorVersionUpgrade - This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

CreateDBInstance, createDBInstance_availabilityZone - The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

CreateDBInstance, createDBInstance_copyTagsToSnapshot - A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

$sel:enablePerformanceInsights:CreateDBInstance', createDBInstance_enablePerformanceInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

$sel:performanceInsightsKMSKeyId:CreateDBInstance', createDBInstance_performanceInsightsKMSKeyId - The KMS key identifier for encryption of Performance Insights data.

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

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

CreateDBInstance, createDBInstance_preferredMaintenanceWindow - The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

CreateDBInstance, createDBInstance_promotionTier - A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

$sel:tags:CreateDBInstance', createDBInstance_tags - The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

CreateDBInstance, createDBInstance_dbInstanceIdentifier - The instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

CreateDBInstance, createDBInstance_dbInstanceClass - The compute and memory capacity of the instance; for example, db.r5.large.

CreateDBInstance, createDBInstance_engine - The name of the database engine to be used for this instance.

Valid value: docdb

CreateDBInstance, createDBInstance_dbClusterIdentifier - The identifier of the cluster that the instance will belong to.

data CreateDBInstanceResponse Source #

See: newCreateDBInstanceResponse smart constructor.

Instances

Instances details
Generic CreateDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Associated Types

type Rep CreateDBInstanceResponse :: Type -> Type #

Read CreateDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Show CreateDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

NFData CreateDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

Eq CreateDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

type Rep CreateDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBInstance

type Rep CreateDBInstanceResponse = D1 ('MetaData "CreateDBInstanceResponse" "Amazonka.DocumentDB.CreateDBInstance" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateDBInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDBInstanceResponse Source #

Create a value of CreateDBInstanceResponse 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:dbInstance:CreateDBInstanceResponse', createDBInstanceResponse_dbInstance - Undocumented member.

$sel:httpStatus:CreateDBInstanceResponse', createDBInstanceResponse_httpStatus - The response's http status code.

CreateDBSubnetGroup

data CreateDBSubnetGroup Source #

Represents the input to CreateDBSubnetGroup.

See: newCreateDBSubnetGroup smart constructor.

Instances

Instances details
ToHeaders CreateDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

ToPath CreateDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

ToQuery CreateDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

AWSRequest CreateDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

Associated Types

type AWSResponse CreateDBSubnetGroup #

Generic CreateDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

Associated Types

type Rep CreateDBSubnetGroup :: Type -> Type #

Read CreateDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

Show CreateDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

NFData CreateDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

Methods

rnf :: CreateDBSubnetGroup -> () #

Eq CreateDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

Hashable CreateDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

type AWSResponse CreateDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

type Rep CreateDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

type Rep CreateDBSubnetGroup = D1 ('MetaData "CreateDBSubnetGroup" "Amazonka.DocumentDB.CreateDBSubnetGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateDBSubnetGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "dbSubnetGroupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newCreateDBSubnetGroup Source #

Create a value of CreateDBSubnetGroup 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:tags:CreateDBSubnetGroup', createDBSubnetGroup_tags - The tags to be assigned to the subnet group.

CreateDBSubnetGroup, createDBSubnetGroup_dbSubnetGroupName - The name for the subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

CreateDBSubnetGroup, createDBSubnetGroup_dbSubnetGroupDescription - The description for the subnet group.

$sel:subnetIds:CreateDBSubnetGroup', createDBSubnetGroup_subnetIds - The Amazon EC2 subnet IDs for the subnet group.

data CreateDBSubnetGroupResponse Source #

See: newCreateDBSubnetGroupResponse smart constructor.

Instances

Instances details
Generic CreateDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

Associated Types

type Rep CreateDBSubnetGroupResponse :: Type -> Type #

Read CreateDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

Show CreateDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

NFData CreateDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

Eq CreateDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

type Rep CreateDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateDBSubnetGroup

type Rep CreateDBSubnetGroupResponse = D1 ('MetaData "CreateDBSubnetGroupResponse" "Amazonka.DocumentDB.CreateDBSubnetGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateDBSubnetGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSubnetGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBSubnetGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDBSubnetGroupResponse Source #

Create a value of CreateDBSubnetGroupResponse 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:

CreateDBSubnetGroupResponse, createDBSubnetGroupResponse_dbSubnetGroup - Undocumented member.

$sel:httpStatus:CreateDBSubnetGroupResponse', createDBSubnetGroupResponse_httpStatus - The response's http status code.

CreateEventSubscription

data CreateEventSubscription Source #

Represents the input to CreateEventSubscription.

See: newCreateEventSubscription smart constructor.

Instances

Instances details
ToHeaders CreateEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

ToPath CreateEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

ToQuery CreateEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

AWSRequest CreateEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

Generic CreateEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

Associated Types

type Rep CreateEventSubscription :: Type -> Type #

Read CreateEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

Show CreateEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

NFData CreateEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

Methods

rnf :: CreateEventSubscription -> () #

Eq CreateEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

Hashable CreateEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

type AWSResponse CreateEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

type Rep CreateEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

type Rep CreateEventSubscription = D1 ('MetaData "CreateEventSubscription" "Amazonka.DocumentDB.CreateEventSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateEventSubscription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "eventCategories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "sourceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "subscriptionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateEventSubscription Source #

Create a value of CreateEventSubscription 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:

CreateEventSubscription, createEventSubscription_enabled - A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

CreateEventSubscription, createEventSubscription_eventCategories - A list of event categories for a SourceType that you want to subscribe to.

$sel:sourceIds:CreateEventSubscription', createEventSubscription_sourceIds - The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If SourceIds are provided, SourceType must also be provided.
  • If the source type is an instance, a DBInstanceIdentifier must be provided.
  • If the source type is a security group, a DBSecurityGroupName must be provided.
  • If the source type is a parameter group, a DBParameterGroupName must be provided.
  • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

CreateEventSubscription, createEventSubscription_sourceType - The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

$sel:tags:CreateEventSubscription', createEventSubscription_tags - The tags to be assigned to the event subscription.

$sel:subscriptionName:CreateEventSubscription', createEventSubscription_subscriptionName - The name of the subscription.

Constraints: The name must be fewer than 255 characters.

CreateEventSubscription, createEventSubscription_snsTopicArn - The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

data CreateEventSubscriptionResponse Source #

See: newCreateEventSubscriptionResponse smart constructor.

Instances

Instances details
Generic CreateEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

Associated Types

type Rep CreateEventSubscriptionResponse :: Type -> Type #

Read CreateEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

Show CreateEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

NFData CreateEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

Eq CreateEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

type Rep CreateEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateEventSubscription

type Rep CreateEventSubscriptionResponse = D1 ('MetaData "CreateEventSubscriptionResponse" "Amazonka.DocumentDB.CreateEventSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateEventSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateEventSubscriptionResponse Source #

Create a value of CreateEventSubscriptionResponse 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:eventSubscription:CreateEventSubscriptionResponse', createEventSubscriptionResponse_eventSubscription - Undocumented member.

$sel:httpStatus:CreateEventSubscriptionResponse', createEventSubscriptionResponse_httpStatus - The response's http status code.

CreateGlobalCluster

data CreateGlobalCluster Source #

Represents the input to CreateGlobalCluster.

See: newCreateGlobalCluster smart constructor.

Instances

Instances details
ToHeaders CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

ToPath CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

ToQuery CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

AWSRequest CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

Associated Types

type AWSResponse CreateGlobalCluster #

Generic CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

Associated Types

type Rep CreateGlobalCluster :: Type -> Type #

Read CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

Show CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

NFData CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

Methods

rnf :: CreateGlobalCluster -> () #

Eq CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

Hashable CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

type AWSResponse CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

type Rep CreateGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

type Rep CreateGlobalCluster = D1 ('MetaData "CreateGlobalCluster" "Amazonka.DocumentDB.CreateGlobalCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateGlobalCluster'" '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 "sourceDBClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateGlobalCluster Source #

Create a value of CreateGlobalCluster 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:

CreateGlobalCluster, createGlobalCluster_databaseName - The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.

CreateGlobalCluster, createGlobalCluster_deletionProtection - The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled.

CreateGlobalCluster, createGlobalCluster_engine - The name of the database engine to be used for this cluster.

CreateGlobalCluster, createGlobalCluster_engineVersion - The engine version of the global cluster.

$sel:sourceDBClusterIdentifier:CreateGlobalCluster', createGlobalCluster_sourceDBClusterIdentifier - The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.

CreateGlobalCluster, createGlobalCluster_storageEncrypted - The storage encryption setting for the new global cluster.

CreateGlobalCluster, createGlobalCluster_globalClusterIdentifier - The cluster identifier of the new global cluster.

data CreateGlobalClusterResponse Source #

See: newCreateGlobalClusterResponse smart constructor.

Instances

Instances details
Generic CreateGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

Associated Types

type Rep CreateGlobalClusterResponse :: Type -> Type #

Read CreateGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

Show CreateGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

NFData CreateGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

Eq CreateGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

type Rep CreateGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.CreateGlobalCluster

type Rep CreateGlobalClusterResponse = D1 ('MetaData "CreateGlobalClusterResponse" "Amazonka.DocumentDB.CreateGlobalCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "CreateGlobalClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GlobalCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateGlobalClusterResponse Source #

Create a value of CreateGlobalClusterResponse 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:globalCluster:CreateGlobalClusterResponse', createGlobalClusterResponse_globalCluster - Undocumented member.

$sel:httpStatus:CreateGlobalClusterResponse', createGlobalClusterResponse_httpStatus - The response's http status code.

DeleteDBCluster

data DeleteDBCluster Source #

Represents the input to DeleteDBCluster.

See: newDeleteDBCluster smart constructor.

Instances

Instances details
ToHeaders DeleteDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

ToPath DeleteDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

ToQuery DeleteDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

AWSRequest DeleteDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

Associated Types

type AWSResponse DeleteDBCluster #

Generic DeleteDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

Associated Types

type Rep DeleteDBCluster :: Type -> Type #

Read DeleteDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

Show DeleteDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

NFData DeleteDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

Methods

rnf :: DeleteDBCluster -> () #

Eq DeleteDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

Hashable DeleteDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

type AWSResponse DeleteDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

type Rep DeleteDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

type Rep DeleteDBCluster = D1 ('MetaData "DeleteDBCluster" "Amazonka.DocumentDB.DeleteDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteDBCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "finalDBSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "skipFinalSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteDBCluster Source #

Create a value of DeleteDBCluster 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:finalDBSnapshotIdentifier:DeleteDBCluster', deleteDBCluster_finalDBSnapshotIdentifier - The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be from 1 to 255 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

$sel:skipFinalSnapshot:DeleteDBCluster', deleteDBCluster_skipFinalSnapshot - Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

DeleteDBCluster, deleteDBCluster_dbClusterIdentifier - The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

data DeleteDBClusterResponse Source #

See: newDeleteDBClusterResponse smart constructor.

Instances

Instances details
Generic DeleteDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

Associated Types

type Rep DeleteDBClusterResponse :: Type -> Type #

Read DeleteDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

Show DeleteDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

NFData DeleteDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

Methods

rnf :: DeleteDBClusterResponse -> () #

Eq DeleteDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

type Rep DeleteDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBCluster

type Rep DeleteDBClusterResponse = D1 ('MetaData "DeleteDBClusterResponse" "Amazonka.DocumentDB.DeleteDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteDBClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteDBClusterResponse Source #

Create a value of DeleteDBClusterResponse 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:dbCluster:DeleteDBClusterResponse', deleteDBClusterResponse_dbCluster - Undocumented member.

$sel:httpStatus:DeleteDBClusterResponse', deleteDBClusterResponse_httpStatus - The response's http status code.

DeleteDBClusterParameterGroup

data DeleteDBClusterParameterGroup Source #

Represents the input to DeleteDBClusterParameterGroup.

See: newDeleteDBClusterParameterGroup smart constructor.

Instances

Instances details
ToHeaders DeleteDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

ToPath DeleteDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

ToQuery DeleteDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

AWSRequest DeleteDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

Generic DeleteDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

Associated Types

type Rep DeleteDBClusterParameterGroup :: Type -> Type #

Read DeleteDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

Show DeleteDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

NFData DeleteDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

Eq DeleteDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

Hashable DeleteDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

type AWSResponse DeleteDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

type Rep DeleteDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

type Rep DeleteDBClusterParameterGroup = D1 ('MetaData "DeleteDBClusterParameterGroup" "Amazonka.DocumentDB.DeleteDBClusterParameterGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteDBClusterParameterGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteDBClusterParameterGroup Source #

Create a value of DeleteDBClusterParameterGroup 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:

DeleteDBClusterParameterGroup, deleteDBClusterParameterGroup_dbClusterParameterGroupName - The name of the cluster parameter group.

Constraints:

  • Must be the name of an existing cluster parameter group.
  • You can't delete a default cluster parameter group.
  • Cannot be associated with any clusters.

data DeleteDBClusterParameterGroupResponse Source #

Instances

Instances details
Generic DeleteDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

Read DeleteDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

Show DeleteDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

NFData DeleteDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

Eq DeleteDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

type Rep DeleteDBClusterParameterGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterParameterGroup

type Rep DeleteDBClusterParameterGroupResponse = D1 ('MetaData "DeleteDBClusterParameterGroupResponse" "Amazonka.DocumentDB.DeleteDBClusterParameterGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteDBClusterParameterGroupResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteDBClusterParameterGroupResponse :: DeleteDBClusterParameterGroupResponse Source #

Create a value of DeleteDBClusterParameterGroupResponse with all optional fields omitted.

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

DeleteDBClusterSnapshot

data DeleteDBClusterSnapshot Source #

Represents the input to DeleteDBClusterSnapshot.

See: newDeleteDBClusterSnapshot smart constructor.

Instances

Instances details
ToHeaders DeleteDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

ToPath DeleteDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

ToQuery DeleteDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

AWSRequest DeleteDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

Generic DeleteDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

Associated Types

type Rep DeleteDBClusterSnapshot :: Type -> Type #

Read DeleteDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

Show DeleteDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

NFData DeleteDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

Methods

rnf :: DeleteDBClusterSnapshot -> () #

Eq DeleteDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

Hashable DeleteDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

type AWSResponse DeleteDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

type Rep DeleteDBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

type Rep DeleteDBClusterSnapshot = D1 ('MetaData "DeleteDBClusterSnapshot" "Amazonka.DocumentDB.DeleteDBClusterSnapshot" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteDBClusterSnapshot'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteDBClusterSnapshot Source #

Create a value of DeleteDBClusterSnapshot 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:

DeleteDBClusterSnapshot, deleteDBClusterSnapshot_dbClusterSnapshotIdentifier - The identifier of the cluster snapshot to delete.

Constraints: Must be the name of an existing cluster snapshot in the available state.

data DeleteDBClusterSnapshotResponse Source #

See: newDeleteDBClusterSnapshotResponse smart constructor.

Instances

Instances details
Generic DeleteDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

Associated Types

type Rep DeleteDBClusterSnapshotResponse :: Type -> Type #

Read DeleteDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

Show DeleteDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

NFData DeleteDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

Eq DeleteDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

type Rep DeleteDBClusterSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBClusterSnapshot

type Rep DeleteDBClusterSnapshotResponse = D1 ('MetaData "DeleteDBClusterSnapshotResponse" "Amazonka.DocumentDB.DeleteDBClusterSnapshot" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteDBClusterSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterSnapshot)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteDBClusterSnapshotResponse Source #

Create a value of DeleteDBClusterSnapshotResponse 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:dbClusterSnapshot:DeleteDBClusterSnapshotResponse', deleteDBClusterSnapshotResponse_dbClusterSnapshot - Undocumented member.

$sel:httpStatus:DeleteDBClusterSnapshotResponse', deleteDBClusterSnapshotResponse_httpStatus - The response's http status code.

DeleteDBInstance

data DeleteDBInstance Source #

Represents the input to DeleteDBInstance.

See: newDeleteDBInstance smart constructor.

Constructors

DeleteDBInstance' Text 

Instances

Instances details
ToHeaders DeleteDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

ToPath DeleteDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

ToQuery DeleteDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

AWSRequest DeleteDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

Associated Types

type AWSResponse DeleteDBInstance #

Generic DeleteDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

Associated Types

type Rep DeleteDBInstance :: Type -> Type #

Read DeleteDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

Show DeleteDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

NFData DeleteDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

Methods

rnf :: DeleteDBInstance -> () #

Eq DeleteDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

Hashable DeleteDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

type AWSResponse DeleteDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

type Rep DeleteDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

type Rep DeleteDBInstance = D1 ('MetaData "DeleteDBInstance" "Amazonka.DocumentDB.DeleteDBInstance" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteDBInstance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteDBInstance Source #

Create a value of DeleteDBInstance 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:

DeleteDBInstance, deleteDBInstance_dbInstanceIdentifier - The instance identifier for the instance to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must match the name of an existing instance.

data DeleteDBInstanceResponse Source #

See: newDeleteDBInstanceResponse smart constructor.

Instances

Instances details
Generic DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

Associated Types

type Rep DeleteDBInstanceResponse :: Type -> Type #

Read DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

Show DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

NFData DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

Eq DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

type Rep DeleteDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBInstance

type Rep DeleteDBInstanceResponse = D1 ('MetaData "DeleteDBInstanceResponse" "Amazonka.DocumentDB.DeleteDBInstance" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteDBInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteDBInstanceResponse Source #

Create a value of DeleteDBInstanceResponse 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:dbInstance:DeleteDBInstanceResponse', deleteDBInstanceResponse_dbInstance - Undocumented member.

$sel:httpStatus:DeleteDBInstanceResponse', deleteDBInstanceResponse_httpStatus - The response's http status code.

DeleteDBSubnetGroup

data DeleteDBSubnetGroup Source #

Represents the input to DeleteDBSubnetGroup.

See: newDeleteDBSubnetGroup smart constructor.

Instances

Instances details
ToHeaders DeleteDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

ToPath DeleteDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

ToQuery DeleteDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

AWSRequest DeleteDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

Associated Types

type AWSResponse DeleteDBSubnetGroup #

Generic DeleteDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

Associated Types

type Rep DeleteDBSubnetGroup :: Type -> Type #

Read DeleteDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

Show DeleteDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

NFData DeleteDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

Methods

rnf :: DeleteDBSubnetGroup -> () #

Eq DeleteDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

Hashable DeleteDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

type AWSResponse DeleteDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

type Rep DeleteDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

type Rep DeleteDBSubnetGroup = D1 ('MetaData "DeleteDBSubnetGroup" "Amazonka.DocumentDB.DeleteDBSubnetGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteDBSubnetGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteDBSubnetGroup Source #

Create a value of DeleteDBSubnetGroup 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:

DeleteDBSubnetGroup, deleteDBSubnetGroup_dbSubnetGroupName - The name of the database subnet group to delete.

You can't delete the default subnet group.

Constraints:

Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

data DeleteDBSubnetGroupResponse Source #

See: newDeleteDBSubnetGroupResponse smart constructor.

Instances

Instances details
Generic DeleteDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

Associated Types

type Rep DeleteDBSubnetGroupResponse :: Type -> Type #

Read DeleteDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

Show DeleteDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

NFData DeleteDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

Eq DeleteDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

type Rep DeleteDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteDBSubnetGroup

type Rep DeleteDBSubnetGroupResponse = D1 ('MetaData "DeleteDBSubnetGroupResponse" "Amazonka.DocumentDB.DeleteDBSubnetGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteDBSubnetGroupResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteDBSubnetGroupResponse :: DeleteDBSubnetGroupResponse Source #

Create a value of DeleteDBSubnetGroupResponse with all optional fields omitted.

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

DeleteEventSubscription

data DeleteEventSubscription Source #

Represents the input to DeleteEventSubscription.

See: newDeleteEventSubscription smart constructor.

Instances

Instances details
ToHeaders DeleteEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

ToPath DeleteEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

ToQuery DeleteEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

AWSRequest DeleteEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

Generic DeleteEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

Associated Types

type Rep DeleteEventSubscription :: Type -> Type #

Read DeleteEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

Show DeleteEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

NFData DeleteEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

Methods

rnf :: DeleteEventSubscription -> () #

Eq DeleteEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

Hashable DeleteEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

type AWSResponse DeleteEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

type Rep DeleteEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

type Rep DeleteEventSubscription = D1 ('MetaData "DeleteEventSubscription" "Amazonka.DocumentDB.DeleteEventSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteEventSubscription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subscriptionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteEventSubscription Source #

Create a value of DeleteEventSubscription 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:subscriptionName:DeleteEventSubscription', deleteEventSubscription_subscriptionName - The name of the Amazon DocumentDB event notification subscription that you want to delete.

data DeleteEventSubscriptionResponse Source #

See: newDeleteEventSubscriptionResponse smart constructor.

Instances

Instances details
Generic DeleteEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

Associated Types

type Rep DeleteEventSubscriptionResponse :: Type -> Type #

Read DeleteEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

Show DeleteEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

NFData DeleteEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

Eq DeleteEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

type Rep DeleteEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteEventSubscription

type Rep DeleteEventSubscriptionResponse = D1 ('MetaData "DeleteEventSubscriptionResponse" "Amazonka.DocumentDB.DeleteEventSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteEventSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteEventSubscriptionResponse Source #

Create a value of DeleteEventSubscriptionResponse 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:eventSubscription:DeleteEventSubscriptionResponse', deleteEventSubscriptionResponse_eventSubscription - Undocumented member.

$sel:httpStatus:DeleteEventSubscriptionResponse', deleteEventSubscriptionResponse_httpStatus - The response's http status code.

DeleteGlobalCluster

data DeleteGlobalCluster Source #

Represents the input to DeleteGlobalCluster.

See: newDeleteGlobalCluster smart constructor.

Instances

Instances details
ToHeaders DeleteGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

ToPath DeleteGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

ToQuery DeleteGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

AWSRequest DeleteGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

Associated Types

type AWSResponse DeleteGlobalCluster #

Generic DeleteGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

Associated Types

type Rep DeleteGlobalCluster :: Type -> Type #

Read DeleteGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

Show DeleteGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

NFData DeleteGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

Methods

rnf :: DeleteGlobalCluster -> () #

Eq DeleteGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

Hashable DeleteGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

type AWSResponse DeleteGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

type Rep DeleteGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

type Rep DeleteGlobalCluster = D1 ('MetaData "DeleteGlobalCluster" "Amazonka.DocumentDB.DeleteGlobalCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteGlobalCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteGlobalCluster Source #

Create a value of DeleteGlobalCluster 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:

DeleteGlobalCluster, deleteGlobalCluster_globalClusterIdentifier - The cluster identifier of the global cluster being deleted.

data DeleteGlobalClusterResponse Source #

See: newDeleteGlobalClusterResponse smart constructor.

Instances

Instances details
Generic DeleteGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

Associated Types

type Rep DeleteGlobalClusterResponse :: Type -> Type #

Read DeleteGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

Show DeleteGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

NFData DeleteGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

Eq DeleteGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

type Rep DeleteGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DeleteGlobalCluster

type Rep DeleteGlobalClusterResponse = D1 ('MetaData "DeleteGlobalClusterResponse" "Amazonka.DocumentDB.DeleteGlobalCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DeleteGlobalClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GlobalCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteGlobalClusterResponse Source #

Create a value of DeleteGlobalClusterResponse 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:globalCluster:DeleteGlobalClusterResponse', deleteGlobalClusterResponse_globalCluster - Undocumented member.

$sel:httpStatus:DeleteGlobalClusterResponse', deleteGlobalClusterResponse_httpStatus - The response's http status code.

DescribeCertificates (Paginated)

data DescribeCertificates Source #

See: newDescribeCertificates smart constructor.

Instances

Instances details
ToHeaders DescribeCertificates Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

ToPath DescribeCertificates Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

ToQuery DescribeCertificates Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

AWSPager DescribeCertificates Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

AWSRequest DescribeCertificates Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

Associated Types

type AWSResponse DescribeCertificates #

Generic DescribeCertificates Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

Associated Types

type Rep DescribeCertificates :: Type -> Type #

Read DescribeCertificates Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

Show DescribeCertificates Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

NFData DescribeCertificates Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

Methods

rnf :: DescribeCertificates -> () #

Eq DescribeCertificates Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

Hashable DescribeCertificates Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

type AWSResponse DescribeCertificates Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

type Rep DescribeCertificates Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

type Rep DescribeCertificates = D1 ('MetaData "DescribeCertificates" "Amazonka.DocumentDB.DescribeCertificates" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeCertificates'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "certificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newDescribeCertificates :: DescribeCertificates Source #

Create a value of DescribeCertificates 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:

DescribeCertificates, describeCertificates_certificateIdentifier - The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

Constraints

  • Must match an existing CertificateIdentifier.

$sel:filters:DescribeCertificates', describeCertificates_filters - This parameter is not currently supported.

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

$sel:maxRecords:DescribeCertificates', describeCertificates_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints:

  • Minimum: 20
  • Maximum: 100

data DescribeCertificatesResponse Source #

See: newDescribeCertificatesResponse smart constructor.

Instances

Instances details
Generic DescribeCertificatesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

Associated Types

type Rep DescribeCertificatesResponse :: Type -> Type #

Read DescribeCertificatesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

Show DescribeCertificatesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

NFData DescribeCertificatesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

Eq DescribeCertificatesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

type Rep DescribeCertificatesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeCertificates

type Rep DescribeCertificatesResponse = D1 ('MetaData "DescribeCertificatesResponse" "Amazonka.DocumentDB.DescribeCertificates" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeCertificatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Certificate])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeCertificatesResponse Source #

Create a value of DescribeCertificatesResponse 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:certificates:DescribeCertificatesResponse', describeCertificatesResponse_certificates - A list of certificates for this Amazon Web Services account.

DescribeCertificates, describeCertificatesResponse_marker - An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.

$sel:httpStatus:DescribeCertificatesResponse', describeCertificatesResponse_httpStatus - The response's http status code.

DescribeDBClusterParameterGroups (Paginated)

data DescribeDBClusterParameterGroups Source #

Represents the input to DescribeDBClusterParameterGroups.

See: newDescribeDBClusterParameterGroups smart constructor.

Instances

Instances details
ToHeaders DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

ToPath DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

ToQuery DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

AWSPager DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

AWSRequest DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

Generic DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

Associated Types

type Rep DescribeDBClusterParameterGroups :: Type -> Type #

Read DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

Show DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

NFData DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

Eq DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

Hashable DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

type AWSResponse DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

type Rep DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

type Rep DescribeDBClusterParameterGroups = D1 ('MetaData "DescribeDBClusterParameterGroups" "Amazonka.DocumentDB.DescribeDBClusterParameterGroups" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBClusterParameterGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newDescribeDBClusterParameterGroups :: DescribeDBClusterParameterGroups Source #

Create a value of DescribeDBClusterParameterGroups 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:

DescribeDBClusterParameterGroups, describeDBClusterParameterGroups_dbClusterParameterGroupName - The name of a specific cluster parameter group to return details for.

Constraints:

  • If provided, must match the name of an existing DBClusterParameterGroup.

$sel:filters:DescribeDBClusterParameterGroups', describeDBClusterParameterGroups_filters - This parameter is not currently supported.

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

$sel:maxRecords:DescribeDBClusterParameterGroups', describeDBClusterParameterGroups_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

data DescribeDBClusterParameterGroupsResponse Source #

Represents the output of DBClusterParameterGroups.

See: newDescribeDBClusterParameterGroupsResponse smart constructor.

Instances

Instances details
Generic DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

Read DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

Show DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

NFData DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

Eq DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

type Rep DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameterGroups

type Rep DescribeDBClusterParameterGroupsResponse = D1 ('MetaData "DescribeDBClusterParameterGroupsResponse" "Amazonka.DocumentDB.DescribeDBClusterParameterGroups" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBClusterParameterGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterParameterGroup])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBClusterParameterGroupsResponse Source #

Create a value of DescribeDBClusterParameterGroupsResponse 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:dbClusterParameterGroups:DescribeDBClusterParameterGroupsResponse', describeDBClusterParameterGroupsResponse_dbClusterParameterGroups - A list of cluster parameter groups.

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

$sel:httpStatus:DescribeDBClusterParameterGroupsResponse', describeDBClusterParameterGroupsResponse_httpStatus - The response's http status code.

DescribeDBClusterParameters (Paginated)

data DescribeDBClusterParameters Source #

Represents the input to DescribeDBClusterParameters.

See: newDescribeDBClusterParameters smart constructor.

Instances

Instances details
ToHeaders DescribeDBClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

ToPath DescribeDBClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

ToQuery DescribeDBClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

AWSPager DescribeDBClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

AWSRequest DescribeDBClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

Generic DescribeDBClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

Associated Types

type Rep DescribeDBClusterParameters :: Type -> Type #

Read DescribeDBClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

Show DescribeDBClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

NFData DescribeDBClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

Eq DescribeDBClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

Hashable DescribeDBClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

type AWSResponse DescribeDBClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

type Rep DescribeDBClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

type Rep DescribeDBClusterParameters = D1 ('MetaData "DescribeDBClusterParameters" "Amazonka.DocumentDB.DescribeDBClusterParameters" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBClusterParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeDBClusterParameters Source #

Create a value of DescribeDBClusterParameters 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:filters:DescribeDBClusterParameters', describeDBClusterParameters_filters - This parameter is not currently supported.

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

$sel:maxRecords:DescribeDBClusterParameters', describeDBClusterParameters_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

DescribeDBClusterParameters, describeDBClusterParameters_source - A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

DescribeDBClusterParameters, describeDBClusterParameters_dbClusterParameterGroupName - The name of a specific cluster parameter group to return parameter details for.

Constraints:

  • If provided, must match the name of an existing DBClusterParameterGroup.

data DescribeDBClusterParametersResponse Source #

Represents the output of DBClusterParameterGroup.

See: newDescribeDBClusterParametersResponse smart constructor.

Instances

Instances details
Generic DescribeDBClusterParametersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

Read DescribeDBClusterParametersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

Show DescribeDBClusterParametersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

NFData DescribeDBClusterParametersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

Eq DescribeDBClusterParametersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

type Rep DescribeDBClusterParametersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterParameters

type Rep DescribeDBClusterParametersResponse = D1 ('MetaData "DescribeDBClusterParametersResponse" "Amazonka.DocumentDB.DescribeDBClusterParameters" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBClusterParametersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBClusterParametersResponse Source #

Create a value of DescribeDBClusterParametersResponse 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:

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

DescribeDBClusterParametersResponse, describeDBClusterParametersResponse_parameters - Provides a list of parameters for the cluster parameter group.

$sel:httpStatus:DescribeDBClusterParametersResponse', describeDBClusterParametersResponse_httpStatus - The response's http status code.

DescribeDBClusterSnapshotAttributes

data DescribeDBClusterSnapshotAttributes Source #

Represents the input to DescribeDBClusterSnapshotAttributes.

See: newDescribeDBClusterSnapshotAttributes smart constructor.

Instances

Instances details
ToHeaders DescribeDBClusterSnapshotAttributes Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

ToPath DescribeDBClusterSnapshotAttributes Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

ToQuery DescribeDBClusterSnapshotAttributes Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

AWSRequest DescribeDBClusterSnapshotAttributes Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

Generic DescribeDBClusterSnapshotAttributes Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

Read DescribeDBClusterSnapshotAttributes Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

Show DescribeDBClusterSnapshotAttributes Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

NFData DescribeDBClusterSnapshotAttributes Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

Eq DescribeDBClusterSnapshotAttributes Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

Hashable DescribeDBClusterSnapshotAttributes Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

type AWSResponse DescribeDBClusterSnapshotAttributes Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

type Rep DescribeDBClusterSnapshotAttributes Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

type Rep DescribeDBClusterSnapshotAttributes = D1 ('MetaData "DescribeDBClusterSnapshotAttributes" "Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBClusterSnapshotAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeDBClusterSnapshotAttributes Source #

Create a value of DescribeDBClusterSnapshotAttributes 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:

DescribeDBClusterSnapshotAttributes, describeDBClusterSnapshotAttributes_dbClusterSnapshotIdentifier - The identifier for the cluster snapshot to describe the attributes for.

data DescribeDBClusterSnapshotAttributesResponse Source #

Instances

Instances details
Generic DescribeDBClusterSnapshotAttributesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

Read DescribeDBClusterSnapshotAttributesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

Show DescribeDBClusterSnapshotAttributesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

NFData DescribeDBClusterSnapshotAttributesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

Eq DescribeDBClusterSnapshotAttributesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

type Rep DescribeDBClusterSnapshotAttributesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes

type Rep DescribeDBClusterSnapshotAttributesResponse = D1 ('MetaData "DescribeDBClusterSnapshotAttributesResponse" "Amazonka.DocumentDB.DescribeDBClusterSnapshotAttributes" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBClusterSnapshotAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshotAttributesResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterSnapshotAttributesResult)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

DescribeDBClusterSnapshots (Paginated)

data DescribeDBClusterSnapshots Source #

Represents the input to DescribeDBClusterSnapshots.

See: newDescribeDBClusterSnapshots smart constructor.

Instances

Instances details
ToHeaders DescribeDBClusterSnapshots Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

ToPath DescribeDBClusterSnapshots Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

ToQuery DescribeDBClusterSnapshots Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

AWSPager DescribeDBClusterSnapshots Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

AWSRequest DescribeDBClusterSnapshots Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

Generic DescribeDBClusterSnapshots Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

Associated Types

type Rep DescribeDBClusterSnapshots :: Type -> Type #

Read DescribeDBClusterSnapshots Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

Show DescribeDBClusterSnapshots Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

NFData DescribeDBClusterSnapshots Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

Eq DescribeDBClusterSnapshots Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

Hashable DescribeDBClusterSnapshots Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

type AWSResponse DescribeDBClusterSnapshots Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

type Rep DescribeDBClusterSnapshots Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

type Rep DescribeDBClusterSnapshots = D1 ('MetaData "DescribeDBClusterSnapshots" "Amazonka.DocumentDB.DescribeDBClusterSnapshots" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBClusterSnapshots'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "includePublic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "includeShared") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "snapshotType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeDBClusterSnapshots :: DescribeDBClusterSnapshots Source #

Create a value of DescribeDBClusterSnapshots 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:

DescribeDBClusterSnapshots, describeDBClusterSnapshots_dbClusterIdentifier - The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

  • If provided, must match the identifier of an existing DBCluster.

DescribeDBClusterSnapshots, describeDBClusterSnapshots_dbClusterSnapshotIdentifier - A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

  • If provided, must match the identifier of an existing DBClusterSnapshot.
  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

$sel:filters:DescribeDBClusterSnapshots', describeDBClusterSnapshots_filters - This parameter is not currently supported.

$sel:includePublic:DescribeDBClusterSnapshots', describeDBClusterSnapshots_includePublic - Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

$sel:includeShared:DescribeDBClusterSnapshots', describeDBClusterSnapshots_includeShared - Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

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

$sel:maxRecords:DescribeDBClusterSnapshots', describeDBClusterSnapshots_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

DescribeDBClusterSnapshots, describeDBClusterSnapshots_snapshotType - The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
  • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
  • shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.
  • public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

data DescribeDBClusterSnapshotsResponse Source #

Represents the output of DescribeDBClusterSnapshots.

See: newDescribeDBClusterSnapshotsResponse smart constructor.

Instances

Instances details
Generic DescribeDBClusterSnapshotsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

Associated Types

type Rep DescribeDBClusterSnapshotsResponse :: Type -> Type #

Read DescribeDBClusterSnapshotsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

Show DescribeDBClusterSnapshotsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

NFData DescribeDBClusterSnapshotsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

Eq DescribeDBClusterSnapshotsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

type Rep DescribeDBClusterSnapshotsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots

type Rep DescribeDBClusterSnapshotsResponse = D1 ('MetaData "DescribeDBClusterSnapshotsResponse" "Amazonka.DocumentDB.DescribeDBClusterSnapshots" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBClusterSnapshotsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterSnapshot])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBClusterSnapshotsResponse Source #

Create a value of DescribeDBClusterSnapshotsResponse 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:dbClusterSnapshots:DescribeDBClusterSnapshotsResponse', describeDBClusterSnapshotsResponse_dbClusterSnapshots - Provides a list of cluster snapshots.

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

$sel:httpStatus:DescribeDBClusterSnapshotsResponse', describeDBClusterSnapshotsResponse_httpStatus - The response's http status code.

DescribeDBClusters (Paginated)

data DescribeDBClusters Source #

Represents the input to DescribeDBClusters.

See: newDescribeDBClusters smart constructor.

Instances

Instances details
ToHeaders DescribeDBClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

ToPath DescribeDBClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

ToQuery DescribeDBClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

AWSPager DescribeDBClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

AWSRequest DescribeDBClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

Associated Types

type AWSResponse DescribeDBClusters #

Generic DescribeDBClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

Associated Types

type Rep DescribeDBClusters :: Type -> Type #

Read DescribeDBClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

Show DescribeDBClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

NFData DescribeDBClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

Methods

rnf :: DescribeDBClusters -> () #

Eq DescribeDBClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

Hashable DescribeDBClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

type AWSResponse DescribeDBClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

type Rep DescribeDBClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

type Rep DescribeDBClusters = D1 ('MetaData "DescribeDBClusters" "Amazonka.DocumentDB.DescribeDBClusters" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBClusters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newDescribeDBClusters :: DescribeDBClusters Source #

Create a value of DescribeDBClusters 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:

DescribeDBClusters, describeDBClusters_dbClusterIdentifier - The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match an existing DBClusterIdentifier.

$sel:filters:DescribeDBClusters', describeDBClusters_filters - A filter that specifies one or more clusters to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

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

$sel:maxRecords:DescribeDBClusters', describeDBClusters_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

data DescribeDBClustersResponse Source #

Represents the output of DescribeDBClusters.

See: newDescribeDBClustersResponse smart constructor.

Instances

Instances details
Generic DescribeDBClustersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

Associated Types

type Rep DescribeDBClustersResponse :: Type -> Type #

Read DescribeDBClustersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

Show DescribeDBClustersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

NFData DescribeDBClustersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

Eq DescribeDBClustersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

type Rep DescribeDBClustersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBClusters

type Rep DescribeDBClustersResponse = D1 ('MetaData "DescribeDBClustersResponse" "Amazonka.DocumentDB.DescribeDBClusters" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBCluster])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBClustersResponse Source #

Create a value of DescribeDBClustersResponse 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:dbClusters:DescribeDBClustersResponse', describeDBClustersResponse_dbClusters - A list of clusters.

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

$sel:httpStatus:DescribeDBClustersResponse', describeDBClustersResponse_httpStatus - The response's http status code.

DescribeDBEngineVersions (Paginated)

data DescribeDBEngineVersions Source #

Represents the input to DescribeDBEngineVersions.

See: newDescribeDBEngineVersions smart constructor.

Instances

Instances details
ToHeaders DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

ToPath DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

ToQuery DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

AWSPager DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

AWSRequest DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Generic DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Associated Types

type Rep DescribeDBEngineVersions :: Type -> Type #

Read DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Show DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

NFData DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Eq DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Hashable DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

type AWSResponse DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

type Rep DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

type Rep DescribeDBEngineVersions = D1 ('MetaData "DescribeDBEngineVersions" "Amazonka.DocumentDB.DescribeDBEngineVersions" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBEngineVersions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultOnly") '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 "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "listSupportedCharacterSets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "listSupportedTimezones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))))

newDescribeDBEngineVersions :: DescribeDBEngineVersions Source #

Create a value of DescribeDBEngineVersions 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:

DescribeDBEngineVersions, describeDBEngineVersions_dbParameterGroupFamily - The name of a specific parameter group family to return details for.

Constraints:

  • If provided, must match an existing DBParameterGroupFamily.

$sel:defaultOnly:DescribeDBEngineVersions', describeDBEngineVersions_defaultOnly - Indicates that only the default version of the specified engine or engine and major version combination is returned.

DescribeDBEngineVersions, describeDBEngineVersions_engine - The database engine to return.

DescribeDBEngineVersions, describeDBEngineVersions_engineVersion - The database engine version to return.

Example: 3.6.0

$sel:filters:DescribeDBEngineVersions', describeDBEngineVersions_filters - This parameter is not currently supported.

$sel:listSupportedCharacterSets:DescribeDBEngineVersions', describeDBEngineVersions_listSupportedCharacterSets - If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

$sel:listSupportedTimezones:DescribeDBEngineVersions', describeDBEngineVersions_listSupportedTimezones - If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

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

$sel:maxRecords:DescribeDBEngineVersions', describeDBEngineVersions_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

data DescribeDBEngineVersionsResponse Source #

Represents the output of DescribeDBEngineVersions.

See: newDescribeDBEngineVersionsResponse smart constructor.

Instances

Instances details
Generic DescribeDBEngineVersionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Associated Types

type Rep DescribeDBEngineVersionsResponse :: Type -> Type #

Read DescribeDBEngineVersionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Show DescribeDBEngineVersionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

NFData DescribeDBEngineVersionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Eq DescribeDBEngineVersionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

type Rep DescribeDBEngineVersionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

type Rep DescribeDBEngineVersionsResponse = D1 ('MetaData "DescribeDBEngineVersionsResponse" "Amazonka.DocumentDB.DescribeDBEngineVersions" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBEngineVersionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbEngineVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBEngineVersion])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBEngineVersionsResponse Source #

Create a value of DescribeDBEngineVersionsResponse 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:dbEngineVersions:DescribeDBEngineVersionsResponse', describeDBEngineVersionsResponse_dbEngineVersions - Detailed information about one or more engine versions.

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

$sel:httpStatus:DescribeDBEngineVersionsResponse', describeDBEngineVersionsResponse_httpStatus - The response's http status code.

DescribeDBInstances (Paginated)

data DescribeDBInstances Source #

Represents the input to DescribeDBInstances.

See: newDescribeDBInstances smart constructor.

Instances

Instances details
ToHeaders DescribeDBInstances Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

ToPath DescribeDBInstances Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

ToQuery DescribeDBInstances Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

AWSPager DescribeDBInstances Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

AWSRequest DescribeDBInstances Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

Associated Types

type AWSResponse DescribeDBInstances #

Generic DescribeDBInstances Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

Associated Types

type Rep DescribeDBInstances :: Type -> Type #

Read DescribeDBInstances Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

Show DescribeDBInstances Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

NFData DescribeDBInstances Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

Methods

rnf :: DescribeDBInstances -> () #

Eq DescribeDBInstances Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

Hashable DescribeDBInstances Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

type AWSResponse DescribeDBInstances Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

type Rep DescribeDBInstances Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

type Rep DescribeDBInstances = D1 ('MetaData "DescribeDBInstances" "Amazonka.DocumentDB.DescribeDBInstances" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBInstances'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newDescribeDBInstances :: DescribeDBInstances Source #

Create a value of DescribeDBInstances 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:

DescribeDBInstances, describeDBInstances_dbInstanceIdentifier - The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match the identifier of an existing DBInstance.

$sel:filters:DescribeDBInstances', describeDBInstances_filters - A filter that specifies one or more instances to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.
  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

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

$sel:maxRecords:DescribeDBInstances', describeDBInstances_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

data DescribeDBInstancesResponse Source #

Represents the output of DescribeDBInstances.

See: newDescribeDBInstancesResponse smart constructor.

Instances

Instances details
Generic DescribeDBInstancesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

Associated Types

type Rep DescribeDBInstancesResponse :: Type -> Type #

Read DescribeDBInstancesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

Show DescribeDBInstancesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

NFData DescribeDBInstancesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

Eq DescribeDBInstancesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

type Rep DescribeDBInstancesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBInstances

type Rep DescribeDBInstancesResponse = D1 ('MetaData "DescribeDBInstancesResponse" "Amazonka.DocumentDB.DescribeDBInstances" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBInstance])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBInstancesResponse Source #

Create a value of DescribeDBInstancesResponse 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:dbInstances:DescribeDBInstancesResponse', describeDBInstancesResponse_dbInstances - Detailed information about one or more instances.

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

$sel:httpStatus:DescribeDBInstancesResponse', describeDBInstancesResponse_httpStatus - The response's http status code.

DescribeDBSubnetGroups (Paginated)

data DescribeDBSubnetGroups Source #

Represents the input to DescribeDBSubnetGroups.

See: newDescribeDBSubnetGroups smart constructor.

Instances

Instances details
ToHeaders DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

ToPath DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

ToQuery DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

AWSPager DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

AWSRequest DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Associated Types

type AWSResponse DescribeDBSubnetGroups #

Generic DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Associated Types

type Rep DescribeDBSubnetGroups :: Type -> Type #

Read DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Show DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

NFData DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

rnf :: DescribeDBSubnetGroups -> () #

Eq DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Hashable DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

type AWSResponse DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

type Rep DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

type Rep DescribeDBSubnetGroups = D1 ('MetaData "DescribeDBSubnetGroups" "Amazonka.DocumentDB.DescribeDBSubnetGroups" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBSubnetGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newDescribeDBSubnetGroups :: DescribeDBSubnetGroups Source #

Create a value of DescribeDBSubnetGroups 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:

DescribeDBSubnetGroups, describeDBSubnetGroups_dbSubnetGroupName - The name of the subnet group to return details for.

$sel:filters:DescribeDBSubnetGroups', describeDBSubnetGroups_filters - This parameter is not currently supported.

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

$sel:maxRecords:DescribeDBSubnetGroups', describeDBSubnetGroups_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

data DescribeDBSubnetGroupsResponse Source #

Represents the output of DescribeDBSubnetGroups.

See: newDescribeDBSubnetGroupsResponse smart constructor.

Instances

Instances details
Generic DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Associated Types

type Rep DescribeDBSubnetGroupsResponse :: Type -> Type #

Read DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Show DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

NFData DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Eq DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

type Rep DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

type Rep DescribeDBSubnetGroupsResponse = D1 ('MetaData "DescribeDBSubnetGroupsResponse" "Amazonka.DocumentDB.DescribeDBSubnetGroups" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBSubnetGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSubnetGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBSubnetGroup])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBSubnetGroupsResponse Source #

Create a value of DescribeDBSubnetGroupsResponse 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:dbSubnetGroups:DescribeDBSubnetGroupsResponse', describeDBSubnetGroupsResponse_dbSubnetGroups - Detailed information about one or more subnet groups.

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

$sel:httpStatus:DescribeDBSubnetGroupsResponse', describeDBSubnetGroupsResponse_httpStatus - The response's http status code.

DescribeEngineDefaultClusterParameters

data DescribeEngineDefaultClusterParameters Source #

Represents the input to DescribeEngineDefaultClusterParameters.

See: newDescribeEngineDefaultClusterParameters smart constructor.

Instances

Instances details
ToHeaders DescribeEngineDefaultClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

ToPath DescribeEngineDefaultClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

ToQuery DescribeEngineDefaultClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

AWSRequest DescribeEngineDefaultClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

Generic DescribeEngineDefaultClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

Read DescribeEngineDefaultClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

Show DescribeEngineDefaultClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

NFData DescribeEngineDefaultClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

Eq DescribeEngineDefaultClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

Hashable DescribeEngineDefaultClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

type AWSResponse DescribeEngineDefaultClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

type Rep DescribeEngineDefaultClusterParameters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

type Rep DescribeEngineDefaultClusterParameters = D1 ('MetaData "DescribeEngineDefaultClusterParameters" "Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeEngineDefaultClusterParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeEngineDefaultClusterParameters Source #

Create a value of DescribeEngineDefaultClusterParameters 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:filters:DescribeEngineDefaultClusterParameters', describeEngineDefaultClusterParameters_filters - This parameter is not currently supported.

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

$sel:maxRecords:DescribeEngineDefaultClusterParameters', describeEngineDefaultClusterParameters_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

DescribeEngineDefaultClusterParameters, describeEngineDefaultClusterParameters_dbParameterGroupFamily - The name of the cluster parameter group family to return the engine parameter information for.

data DescribeEngineDefaultClusterParametersResponse Source #

Instances

Instances details
Generic DescribeEngineDefaultClusterParametersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

Read DescribeEngineDefaultClusterParametersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

Show DescribeEngineDefaultClusterParametersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

NFData DescribeEngineDefaultClusterParametersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

Eq DescribeEngineDefaultClusterParametersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

type Rep DescribeEngineDefaultClusterParametersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters

type Rep DescribeEngineDefaultClusterParametersResponse = D1 ('MetaData "DescribeEngineDefaultClusterParametersResponse" "Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeEngineDefaultClusterParametersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "engineDefaults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EngineDefaults)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

DescribeEventCategories

data DescribeEventCategories Source #

Represents the input to DescribeEventCategories.

See: newDescribeEventCategories smart constructor.

Instances

Instances details
ToHeaders DescribeEventCategories Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

ToPath DescribeEventCategories Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

ToQuery DescribeEventCategories Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

AWSRequest DescribeEventCategories Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

Generic DescribeEventCategories Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

Associated Types

type Rep DescribeEventCategories :: Type -> Type #

Read DescribeEventCategories Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

Show DescribeEventCategories Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

NFData DescribeEventCategories Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

Methods

rnf :: DescribeEventCategories -> () #

Eq DescribeEventCategories Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

Hashable DescribeEventCategories Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

type AWSResponse DescribeEventCategories Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

type Rep DescribeEventCategories Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

type Rep DescribeEventCategories = D1 ('MetaData "DescribeEventCategories" "Amazonka.DocumentDB.DescribeEventCategories" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeEventCategories'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDescribeEventCategories :: DescribeEventCategories Source #

Create a value of DescribeEventCategories 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:filters:DescribeEventCategories', describeEventCategories_filters - This parameter is not currently supported.

DescribeEventCategories, describeEventCategories_sourceType - The type of source that is generating the events.

Valid values: db-instance, db-parameter-group, db-security-group

data DescribeEventCategoriesResponse Source #

Represents the output of DescribeEventCategories.

See: newDescribeEventCategoriesResponse smart constructor.

Instances

Instances details
Generic DescribeEventCategoriesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

Associated Types

type Rep DescribeEventCategoriesResponse :: Type -> Type #

Read DescribeEventCategoriesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

Show DescribeEventCategoriesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

NFData DescribeEventCategoriesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

Eq DescribeEventCategoriesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

type Rep DescribeEventCategoriesResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventCategories

type Rep DescribeEventCategoriesResponse = D1 ('MetaData "DescribeEventCategoriesResponse" "Amazonka.DocumentDB.DescribeEventCategories" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeEventCategoriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventCategoriesMapList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventCategoriesMap])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeEventCategoriesResponse Source #

Create a value of DescribeEventCategoriesResponse 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:eventCategoriesMapList:DescribeEventCategoriesResponse', describeEventCategoriesResponse_eventCategoriesMapList - A list of event category maps.

$sel:httpStatus:DescribeEventCategoriesResponse', describeEventCategoriesResponse_httpStatus - The response's http status code.

DescribeEventSubscriptions (Paginated)

data DescribeEventSubscriptions Source #

Represents the input to DescribeEventSubscriptions.

See: newDescribeEventSubscriptions smart constructor.

Instances

Instances details
ToHeaders DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

ToPath DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

ToQuery DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

AWSPager DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

AWSRequest DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

Generic DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

Associated Types

type Rep DescribeEventSubscriptions :: Type -> Type #

Read DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

Show DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

NFData DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

Eq DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

Hashable DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

type AWSResponse DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

type Rep DescribeEventSubscriptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

type Rep DescribeEventSubscriptions = D1 ('MetaData "DescribeEventSubscriptions" "Amazonka.DocumentDB.DescribeEventSubscriptions" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeEventSubscriptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "subscriptionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeEventSubscriptions :: DescribeEventSubscriptions Source #

Create a value of DescribeEventSubscriptions 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:filters:DescribeEventSubscriptions', describeEventSubscriptions_filters - This parameter is not currently supported.

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

$sel:maxRecords:DescribeEventSubscriptions', describeEventSubscriptions_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

$sel:subscriptionName:DescribeEventSubscriptions', describeEventSubscriptions_subscriptionName - The name of the Amazon DocumentDB event notification subscription that you want to describe.

data DescribeEventSubscriptionsResponse Source #

Represents the output of DescribeEventSubscriptions.

See: newDescribeEventSubscriptionsResponse smart constructor.

Instances

Instances details
Generic DescribeEventSubscriptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

Associated Types

type Rep DescribeEventSubscriptionsResponse :: Type -> Type #

Read DescribeEventSubscriptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

Show DescribeEventSubscriptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

NFData DescribeEventSubscriptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

Eq DescribeEventSubscriptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

type Rep DescribeEventSubscriptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEventSubscriptions

type Rep DescribeEventSubscriptionsResponse = D1 ('MetaData "DescribeEventSubscriptionsResponse" "Amazonka.DocumentDB.DescribeEventSubscriptions" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeEventSubscriptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscriptionsList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventSubscription])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEventSubscriptionsResponse Source #

Create a value of DescribeEventSubscriptionsResponse 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:eventSubscriptionsList:DescribeEventSubscriptionsResponse', describeEventSubscriptionsResponse_eventSubscriptionsList - A list of event subscriptions.

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

$sel:httpStatus:DescribeEventSubscriptionsResponse', describeEventSubscriptionsResponse_httpStatus - The response's http status code.

DescribeEvents (Paginated)

data DescribeEvents Source #

Represents the input to DescribeEvents.

See: newDescribeEvents smart constructor.

Instances

Instances details
ToHeaders DescribeEvents Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

ToPath DescribeEvents Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

ToQuery DescribeEvents Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

AWSPager DescribeEvents Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

AWSRequest DescribeEvents Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

Associated Types

type AWSResponse DescribeEvents #

Generic DescribeEvents Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

Associated Types

type Rep DescribeEvents :: Type -> Type #

Read DescribeEvents Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

Show DescribeEvents Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

NFData DescribeEvents Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

rnf :: DescribeEvents -> () #

Eq DescribeEvents Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

Hashable DescribeEvents Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

type AWSResponse DescribeEvents Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

type Rep DescribeEvents Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

newDescribeEvents :: DescribeEvents Source #

Create a value of DescribeEvents 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:duration:DescribeEvents', describeEvents_duration - The number of minutes to retrieve events for.

Default: 60

$sel:endTime:DescribeEvents', describeEvents_endTime - The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

DescribeEvents, describeEvents_eventCategories - A list of event categories that trigger notifications for an event notification subscription.

$sel:filters:DescribeEvents', describeEvents_filters - This parameter is not currently supported.

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

$sel:maxRecords:DescribeEvents', describeEvents_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

DescribeEvents, describeEvents_sourceIdentifier - The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.
  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.
  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.
  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.
  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.
  • Cannot end with a hyphen or contain two consecutive hyphens.

DescribeEvents, describeEvents_sourceType - The event source to retrieve events for. If no value is specified, all events are returned.

$sel:startTime:DescribeEvents', describeEvents_startTime - The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

data DescribeEventsResponse Source #

Represents the output of DescribeEvents.

See: newDescribeEventsResponse smart constructor.

Instances

Instances details
Generic DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

Associated Types

type Rep DescribeEventsResponse :: Type -> Type #

Read DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

Show DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

NFData DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

Methods

rnf :: DescribeEventsResponse -> () #

Eq DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

type Rep DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeEvents

type Rep DescribeEventsResponse = D1 ('MetaData "DescribeEventsResponse" "Amazonka.DocumentDB.DescribeEvents" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Event])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEventsResponse Source #

Create a value of DescribeEventsResponse 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:events:DescribeEventsResponse', describeEventsResponse_events - Detailed information about one or more events.

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

$sel:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.

DescribeGlobalClusters (Paginated)

data DescribeGlobalClusters Source #

See: newDescribeGlobalClusters smart constructor.

Instances

Instances details
ToHeaders DescribeGlobalClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

ToPath DescribeGlobalClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

ToQuery DescribeGlobalClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

AWSPager DescribeGlobalClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

AWSRequest DescribeGlobalClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Associated Types

type AWSResponse DescribeGlobalClusters #

Generic DescribeGlobalClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Associated Types

type Rep DescribeGlobalClusters :: Type -> Type #

Read DescribeGlobalClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Show DescribeGlobalClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

NFData DescribeGlobalClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

rnf :: DescribeGlobalClusters -> () #

Eq DescribeGlobalClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Hashable DescribeGlobalClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

type AWSResponse DescribeGlobalClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

type Rep DescribeGlobalClusters Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

type Rep DescribeGlobalClusters = D1 ('MetaData "DescribeGlobalClusters" "Amazonka.DocumentDB.DescribeGlobalClusters" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeGlobalClusters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newDescribeGlobalClusters :: DescribeGlobalClusters Source #

Create a value of DescribeGlobalClusters 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:filters:DescribeGlobalClusters', describeGlobalClusters_filters - A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

DescribeGlobalClusters, describeGlobalClusters_globalClusterIdentifier - The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.

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

$sel:maxRecords:DescribeGlobalClusters', describeGlobalClusters_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

data DescribeGlobalClustersResponse Source #

See: newDescribeGlobalClustersResponse smart constructor.

Instances

Instances details
Generic DescribeGlobalClustersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Associated Types

type Rep DescribeGlobalClustersResponse :: Type -> Type #

Read DescribeGlobalClustersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Show DescribeGlobalClustersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

NFData DescribeGlobalClustersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Eq DescribeGlobalClustersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

type Rep DescribeGlobalClustersResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

type Rep DescribeGlobalClustersResponse = D1 ('MetaData "DescribeGlobalClustersResponse" "Amazonka.DocumentDB.DescribeGlobalClusters" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeGlobalClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalClusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlobalCluster])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

DescribeOrderableDBInstanceOptions (Paginated)

data DescribeOrderableDBInstanceOptions Source #

Represents the input to DescribeOrderableDBInstanceOptions.

See: newDescribeOrderableDBInstanceOptions smart constructor.

Instances

Instances details
ToHeaders DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

ToPath DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

ToQuery DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

AWSPager DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

AWSRequest DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Generic DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Associated Types

type Rep DescribeOrderableDBInstanceOptions :: Type -> Type #

Read DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Show DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

NFData DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Eq DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Hashable DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

type AWSResponse DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

type Rep DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

type Rep DescribeOrderableDBInstanceOptions = D1 ('MetaData "DescribeOrderableDBInstanceOptions" "Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeOrderableDBInstanceOptions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "vpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeOrderableDBInstanceOptions Source #

Create a value of DescribeOrderableDBInstanceOptions 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:

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_dbInstanceClass - The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_engineVersion - The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

$sel:filters:DescribeOrderableDBInstanceOptions', describeOrderableDBInstanceOptions_filters - This parameter is not currently supported.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_licenseModel - The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

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

$sel:maxRecords:DescribeOrderableDBInstanceOptions', describeOrderableDBInstanceOptions_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_vpc - The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_engine - The name of the engine to retrieve instance options for.

data DescribeOrderableDBInstanceOptionsResponse Source #

Represents the output of DescribeOrderableDBInstanceOptions.

See: newDescribeOrderableDBInstanceOptionsResponse smart constructor.

Instances

Instances details
Generic DescribeOrderableDBInstanceOptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Read DescribeOrderableDBInstanceOptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Show DescribeOrderableDBInstanceOptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

NFData DescribeOrderableDBInstanceOptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Eq DescribeOrderableDBInstanceOptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

type Rep DescribeOrderableDBInstanceOptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

type Rep DescribeOrderableDBInstanceOptionsResponse = D1 ('MetaData "DescribeOrderableDBInstanceOptionsResponse" "Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeOrderableDBInstanceOptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "orderableDBInstanceOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OrderableDBInstanceOption])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeOrderableDBInstanceOptionsResponse Source #

Create a value of DescribeOrderableDBInstanceOptionsResponse 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:

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

$sel:orderableDBInstanceOptions:DescribeOrderableDBInstanceOptionsResponse', describeOrderableDBInstanceOptionsResponse_orderableDBInstanceOptions - The options that are available for a particular orderable instance.

$sel:httpStatus:DescribeOrderableDBInstanceOptionsResponse', describeOrderableDBInstanceOptionsResponse_httpStatus - The response's http status code.

DescribePendingMaintenanceActions (Paginated)

data DescribePendingMaintenanceActions Source #

Represents the input to DescribePendingMaintenanceActions.

See: newDescribePendingMaintenanceActions smart constructor.

Instances

Instances details
ToHeaders DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

ToPath DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

ToQuery DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

AWSPager DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

AWSRequest DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Generic DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Associated Types

type Rep DescribePendingMaintenanceActions :: Type -> Type #

Read DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Show DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

NFData DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Eq DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Hashable DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

type AWSResponse DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

type Rep DescribePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

type Rep DescribePendingMaintenanceActions = D1 ('MetaData "DescribePendingMaintenanceActions" "Amazonka.DocumentDB.DescribePendingMaintenanceActions" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribePendingMaintenanceActions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "resourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribePendingMaintenanceActions :: DescribePendingMaintenanceActions Source #

Create a value of DescribePendingMaintenanceActions 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:filters:DescribePendingMaintenanceActions', describePendingMaintenanceActions_filters - A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.
  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.

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

$sel:maxRecords:DescribePendingMaintenanceActions', describePendingMaintenanceActions_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

DescribePendingMaintenanceActions, describePendingMaintenanceActions_resourceIdentifier - The ARN of a resource to return pending maintenance actions for.

data DescribePendingMaintenanceActionsResponse Source #

Represents the output of DescribePendingMaintenanceActions.

See: newDescribePendingMaintenanceActionsResponse smart constructor.

Instances

Instances details
Generic DescribePendingMaintenanceActionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Read DescribePendingMaintenanceActionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Show DescribePendingMaintenanceActionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

NFData DescribePendingMaintenanceActionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

Eq DescribePendingMaintenanceActionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

type Rep DescribePendingMaintenanceActionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribePendingMaintenanceActions

type Rep DescribePendingMaintenanceActionsResponse = D1 ('MetaData "DescribePendingMaintenanceActionsResponse" "Amazonka.DocumentDB.DescribePendingMaintenanceActions" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribePendingMaintenanceActionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pendingMaintenanceActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourcePendingMaintenanceActions])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribePendingMaintenanceActionsResponse Source #

Create a value of DescribePendingMaintenanceActionsResponse 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:

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

$sel:pendingMaintenanceActions:DescribePendingMaintenanceActionsResponse', describePendingMaintenanceActionsResponse_pendingMaintenanceActions - The maintenance actions to be applied.

$sel:httpStatus:DescribePendingMaintenanceActionsResponse', describePendingMaintenanceActionsResponse_httpStatus - The response's http status code.

FailoverDBCluster

data FailoverDBCluster Source #

Represents the input to FailoverDBCluster.

See: newFailoverDBCluster smart constructor.

Instances

Instances details
ToHeaders FailoverDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

ToPath FailoverDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

ToQuery FailoverDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

AWSRequest FailoverDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

Associated Types

type AWSResponse FailoverDBCluster #

Generic FailoverDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

Associated Types

type Rep FailoverDBCluster :: Type -> Type #

Read FailoverDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

Show FailoverDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

NFData FailoverDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

Methods

rnf :: FailoverDBCluster -> () #

Eq FailoverDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

Hashable FailoverDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

type AWSResponse FailoverDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

type Rep FailoverDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

type Rep FailoverDBCluster = D1 ('MetaData "FailoverDBCluster" "Amazonka.DocumentDB.FailoverDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "FailoverDBCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "targetDBInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newFailoverDBCluster :: FailoverDBCluster Source #

Create a value of FailoverDBCluster 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:

FailoverDBCluster, failoverDBCluster_dbClusterIdentifier - A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

$sel:targetDBInstanceIdentifier:FailoverDBCluster', failoverDBCluster_targetDBInstanceIdentifier - The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

data FailoverDBClusterResponse Source #

See: newFailoverDBClusterResponse smart constructor.

Instances

Instances details
Generic FailoverDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

Associated Types

type Rep FailoverDBClusterResponse :: Type -> Type #

Read FailoverDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

Show FailoverDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

NFData FailoverDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

Eq FailoverDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

type Rep FailoverDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.FailoverDBCluster

type Rep FailoverDBClusterResponse = D1 ('MetaData "FailoverDBClusterResponse" "Amazonka.DocumentDB.FailoverDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "FailoverDBClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newFailoverDBClusterResponse Source #

Create a value of FailoverDBClusterResponse 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:dbCluster:FailoverDBClusterResponse', failoverDBClusterResponse_dbCluster - Undocumented member.

$sel:httpStatus:FailoverDBClusterResponse', failoverDBClusterResponse_httpStatus - The response's http status code.

ListTagsForResource

data ListTagsForResource Source #

Represents the input to ListTagsForResource.

See: newListTagsForResource smart constructor.

Instances

Instances details
ToHeaders ListTagsForResource Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

ToPath ListTagsForResource Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

ToQuery ListTagsForResource Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

AWSRequest ListTagsForResource Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

Associated Types

type AWSResponse ListTagsForResource #

Generic ListTagsForResource Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

Associated Types

type Rep ListTagsForResource :: Type -> Type #

Read ListTagsForResource Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

Show ListTagsForResource Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

NFData ListTagsForResource Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

Methods

rnf :: ListTagsForResource -> () #

Eq ListTagsForResource Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

Hashable ListTagsForResource Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

type AWSResponse ListTagsForResource Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

type Rep ListTagsForResource Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

type Rep ListTagsForResource = D1 ('MetaData "ListTagsForResource" "Amazonka.DocumentDB.ListTagsForResource" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ListTagsForResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "resourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newListTagsForResource Source #

Create a value of ListTagsForResource 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:filters:ListTagsForResource', listTagsForResource_filters - This parameter is not currently supported.

$sel:resourceName:ListTagsForResource', listTagsForResource_resourceName - The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

data ListTagsForResourceResponse Source #

Represents the output of ListTagsForResource.

See: newListTagsForResourceResponse smart constructor.

Instances

Instances details
Generic ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

Associated Types

type Rep ListTagsForResourceResponse :: Type -> Type #

Read ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

Show ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

NFData ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

Eq ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

type Rep ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ListTagsForResource

type Rep ListTagsForResourceResponse = D1 ('MetaData "ListTagsForResourceResponse" "Amazonka.DocumentDB.ListTagsForResource" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ListTagsForResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newListTagsForResourceResponse Source #

Create a value of ListTagsForResourceResponse 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:tagList:ListTagsForResourceResponse', listTagsForResourceResponse_tagList - A list of one or more tags.

$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.

ModifyDBCluster

data ModifyDBCluster Source #

Represents the input to ModifyDBCluster.

See: newModifyDBCluster smart constructor.

Instances

Instances details
ToHeaders ModifyDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

ToPath ModifyDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

ToQuery ModifyDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

AWSRequest ModifyDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

Associated Types

type AWSResponse ModifyDBCluster #

Generic ModifyDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

Associated Types

type Rep ModifyDBCluster :: Type -> Type #

Read ModifyDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

Show ModifyDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

NFData ModifyDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

Methods

rnf :: ModifyDBCluster -> () #

Eq ModifyDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

Hashable ModifyDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

type AWSResponse ModifyDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

type Rep ModifyDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

type Rep ModifyDBCluster = D1 ('MetaData "ModifyDBCluster" "Amazonka.DocumentDB.ModifyDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyDBCluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applyImmediately") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "cloudwatchLogsExportConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudwatchLogsExportConfiguration)))) :*: (S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "masterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "newDBClusterIdentifier'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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 "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newModifyDBCluster Source #

Create a value of ModifyDBCluster 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:applyImmediately:ModifyDBCluster', modifyDBCluster_applyImmediately - A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

ModifyDBCluster, modifyDBCluster_backupRetentionPeriod - The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35.

$sel:cloudwatchLogsExportConfiguration:ModifyDBCluster', modifyDBCluster_cloudwatchLogsExportConfiguration - The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

ModifyDBCluster, modifyDBCluster_dbClusterParameterGroupName - The name of the cluster parameter group to use for the cluster.

ModifyDBCluster, modifyDBCluster_deletionProtection - Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

ModifyDBCluster, modifyDBCluster_engineVersion - The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.

ModifyDBCluster, modifyDBCluster_masterUserPassword - The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

$sel:newDBClusterIdentifier':ModifyDBCluster', modifyDBCluster_newDBClusterIdentifier - The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster2

ModifyDBCluster, modifyDBCluster_port - The port number on which the cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

ModifyDBCluster, modifyDBCluster_preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

ModifyDBCluster, modifyDBCluster_preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

$sel:vpcSecurityGroupIds:ModifyDBCluster', modifyDBCluster_vpcSecurityGroupIds - A list of virtual private cloud (VPC) security groups that the cluster will belong to.

ModifyDBCluster, modifyDBCluster_dbClusterIdentifier - The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

data ModifyDBClusterResponse Source #

See: newModifyDBClusterResponse smart constructor.

Instances

Instances details
Generic ModifyDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

Associated Types

type Rep ModifyDBClusterResponse :: Type -> Type #

Read ModifyDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

Show ModifyDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

NFData ModifyDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

Methods

rnf :: ModifyDBClusterResponse -> () #

Eq ModifyDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

type Rep ModifyDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBCluster

type Rep ModifyDBClusterResponse = D1 ('MetaData "ModifyDBClusterResponse" "Amazonka.DocumentDB.ModifyDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyDBClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyDBClusterResponse Source #

Create a value of ModifyDBClusterResponse 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:dbCluster:ModifyDBClusterResponse', modifyDBClusterResponse_dbCluster - Undocumented member.

$sel:httpStatus:ModifyDBClusterResponse', modifyDBClusterResponse_httpStatus - The response's http status code.

ModifyDBClusterParameterGroup

data ModifyDBClusterParameterGroup Source #

Represents the input to ModifyDBClusterParameterGroup.

See: newModifyDBClusterParameterGroup smart constructor.

Instances

Instances details
ToHeaders ModifyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup

ToPath ModifyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup

ToQuery ModifyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup

AWSRequest ModifyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup

Generic ModifyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup

Associated Types

type Rep ModifyDBClusterParameterGroup :: Type -> Type #

Read ModifyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup

Show ModifyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup

NFData ModifyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup

Eq ModifyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup

Hashable ModifyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup

type AWSResponse ModifyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup

type Rep ModifyDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup

type Rep ModifyDBClusterParameterGroup = D1 ('MetaData "ModifyDBClusterParameterGroup" "Amazonka.DocumentDB.ModifyDBClusterParameterGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyDBClusterParameterGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Parameter])))

newModifyDBClusterParameterGroup Source #

Create a value of ModifyDBClusterParameterGroup 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:

ModifyDBClusterParameterGroup, modifyDBClusterParameterGroup_dbClusterParameterGroupName - The name of the cluster parameter group to modify.

ModifyDBClusterParameterGroup, modifyDBClusterParameterGroup_parameters - A list of parameters in the cluster parameter group to modify.

data DBClusterParameterGroupNameMessage Source #

Contains the name of a cluster parameter group.

See: newDBClusterParameterGroupNameMessage smart constructor.

Instances

Instances details
FromXML DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Generic DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Associated Types

type Rep DBClusterParameterGroupNameMessage :: Type -> Type #

Read DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Show DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

NFData DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Eq DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Hashable DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

type Rep DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

type Rep DBClusterParameterGroupNameMessage = D1 ('MetaData "DBClusterParameterGroupNameMessage" "Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 a cluster parameter group.

Constraints:

  • Must be from 1 to 255 letters or numbers.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

ModifyDBClusterSnapshotAttribute

data ModifyDBClusterSnapshotAttribute Source #

Represents the input to ModifyDBClusterSnapshotAttribute.

See: newModifyDBClusterSnapshotAttribute smart constructor.

Instances

Instances details
ToHeaders ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

ToPath ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

ToQuery ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

AWSRequest ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

Generic ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

Associated Types

type Rep ModifyDBClusterSnapshotAttribute :: Type -> Type #

Read ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

Show ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

NFData ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

Eq ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

Hashable ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

type AWSResponse ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

type Rep ModifyDBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

type Rep ModifyDBClusterSnapshotAttribute = D1 ('MetaData "ModifyDBClusterSnapshotAttribute" "Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyDBClusterSnapshotAttribute'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "valuesToAdd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "valuesToRemove") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newModifyDBClusterSnapshotAttribute Source #

Create a value of ModifyDBClusterSnapshotAttribute 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:valuesToAdd:ModifyDBClusterSnapshotAttribute', modifyDBClusterSnapshotAttribute_valuesToAdd - A list of cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all Amazon Web Services accounts.

$sel:valuesToRemove:ModifyDBClusterSnapshotAttribute', modifyDBClusterSnapshotAttribute_valuesToRemove - A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.

ModifyDBClusterSnapshotAttribute, modifyDBClusterSnapshotAttribute_dbClusterSnapshotIdentifier - The identifier for the cluster snapshot to modify the attributes for.

ModifyDBClusterSnapshotAttribute, modifyDBClusterSnapshotAttribute_attributeName - The name of the cluster snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this value to restore.

data ModifyDBClusterSnapshotAttributeResponse Source #

Instances

Instances details
Generic ModifyDBClusterSnapshotAttributeResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

Read ModifyDBClusterSnapshotAttributeResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

Show ModifyDBClusterSnapshotAttributeResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

NFData ModifyDBClusterSnapshotAttributeResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

Eq ModifyDBClusterSnapshotAttributeResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

type Rep ModifyDBClusterSnapshotAttributeResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute

type Rep ModifyDBClusterSnapshotAttributeResponse = D1 ('MetaData "ModifyDBClusterSnapshotAttributeResponse" "Amazonka.DocumentDB.ModifyDBClusterSnapshotAttribute" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyDBClusterSnapshotAttributeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshotAttributesResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBClusterSnapshotAttributesResult)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

ModifyDBInstance

data ModifyDBInstance Source #

Represents the input to ModifyDBInstance.

See: newModifyDBInstance smart constructor.

Instances

Instances details
ToHeaders ModifyDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

ToPath ModifyDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

ToQuery ModifyDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

AWSRequest ModifyDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

Associated Types

type AWSResponse ModifyDBInstance #

Generic ModifyDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

Associated Types

type Rep ModifyDBInstance :: Type -> Type #

Read ModifyDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

Show ModifyDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

NFData ModifyDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

Methods

rnf :: ModifyDBInstance -> () #

Eq ModifyDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

Hashable ModifyDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

type AWSResponse ModifyDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

type Rep ModifyDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

type Rep ModifyDBInstance = D1 ('MetaData "ModifyDBInstance" "Amazonka.DocumentDB.ModifyDBInstance" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyDBInstance'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applyImmediately") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "cACertificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "enablePerformanceInsights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "newDBInstanceIdentifier'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "performanceInsightsKMSKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "promotionTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newModifyDBInstance Source #

Create a value of ModifyDBInstance 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:applyImmediately:ModifyDBInstance', modifyDBInstance_applyImmediately - Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

Default: false

ModifyDBInstance, modifyDBInstance_autoMinorVersionUpgrade - This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

ModifyDBInstance, modifyDBInstance_cACertificateIdentifier - Indicates the certificate that needs to be associated with the instance.

ModifyDBInstance, modifyDBInstance_copyTagsToSnapshot - A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

ModifyDBInstance, modifyDBInstance_dbInstanceClass - The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.

If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting.

$sel:enablePerformanceInsights:ModifyDBInstance', modifyDBInstance_enablePerformanceInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

$sel:newDBInstanceIdentifier':ModifyDBInstance', modifyDBInstance_newDBInstanceIdentifier - The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

$sel:performanceInsightsKMSKeyId:ModifyDBInstance', modifyDBInstance_performanceInsightsKMSKeyId - The KMS key identifier for encryption of Performance Insights data.

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

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

ModifyDBInstance, modifyDBInstance_preferredMaintenanceWindow - The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Must be at least 30 minutes.

ModifyDBInstance, modifyDBInstance_promotionTier - A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

ModifyDBInstance, modifyDBInstance_dbInstanceIdentifier - The instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

data ModifyDBInstanceResponse Source #

See: newModifyDBInstanceResponse smart constructor.

Instances

Instances details
Generic ModifyDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

Associated Types

type Rep ModifyDBInstanceResponse :: Type -> Type #

Read ModifyDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

Show ModifyDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

NFData ModifyDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

Eq ModifyDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

type Rep ModifyDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBInstance

type Rep ModifyDBInstanceResponse = D1 ('MetaData "ModifyDBInstanceResponse" "Amazonka.DocumentDB.ModifyDBInstance" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyDBInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyDBInstanceResponse Source #

Create a value of ModifyDBInstanceResponse 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:dbInstance:ModifyDBInstanceResponse', modifyDBInstanceResponse_dbInstance - Undocumented member.

$sel:httpStatus:ModifyDBInstanceResponse', modifyDBInstanceResponse_httpStatus - The response's http status code.

ModifyDBSubnetGroup

data ModifyDBSubnetGroup Source #

Represents the input to ModifyDBSubnetGroup.

See: newModifyDBSubnetGroup smart constructor.

Instances

Instances details
ToHeaders ModifyDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

ToPath ModifyDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

ToQuery ModifyDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

AWSRequest ModifyDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

Associated Types

type AWSResponse ModifyDBSubnetGroup #

Generic ModifyDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

Associated Types

type Rep ModifyDBSubnetGroup :: Type -> Type #

Read ModifyDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

Show ModifyDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

NFData ModifyDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

Methods

rnf :: ModifyDBSubnetGroup -> () #

Eq ModifyDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

Hashable ModifyDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

type AWSResponse ModifyDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

type Rep ModifyDBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

type Rep ModifyDBSubnetGroup = D1 ('MetaData "ModifyDBSubnetGroup" "Amazonka.DocumentDB.ModifyDBSubnetGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyDBSubnetGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSubnetGroupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newModifyDBSubnetGroup Source #

Create a value of ModifyDBSubnetGroup 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:

ModifyDBSubnetGroup, modifyDBSubnetGroup_dbSubnetGroupDescription - The description for the subnet group.

ModifyDBSubnetGroup, modifyDBSubnetGroup_dbSubnetGroupName - The name for the subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

$sel:subnetIds:ModifyDBSubnetGroup', modifyDBSubnetGroup_subnetIds - The Amazon EC2 subnet IDs for the subnet group.

data ModifyDBSubnetGroupResponse Source #

See: newModifyDBSubnetGroupResponse smart constructor.

Instances

Instances details
Generic ModifyDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

Associated Types

type Rep ModifyDBSubnetGroupResponse :: Type -> Type #

Read ModifyDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

Show ModifyDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

NFData ModifyDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

Eq ModifyDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

type Rep ModifyDBSubnetGroupResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyDBSubnetGroup

type Rep ModifyDBSubnetGroupResponse = D1 ('MetaData "ModifyDBSubnetGroupResponse" "Amazonka.DocumentDB.ModifyDBSubnetGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyDBSubnetGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSubnetGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBSubnetGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyDBSubnetGroupResponse Source #

Create a value of ModifyDBSubnetGroupResponse 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:

ModifyDBSubnetGroupResponse, modifyDBSubnetGroupResponse_dbSubnetGroup - Undocumented member.

$sel:httpStatus:ModifyDBSubnetGroupResponse', modifyDBSubnetGroupResponse_httpStatus - The response's http status code.

ModifyEventSubscription

data ModifyEventSubscription Source #

Represents the input to ModifyEventSubscription.

See: newModifyEventSubscription smart constructor.

Instances

Instances details
ToHeaders ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

ToPath ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

ToQuery ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

AWSRequest ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Generic ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Associated Types

type Rep ModifyEventSubscription :: Type -> Type #

Read ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Show ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

NFData ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Methods

rnf :: ModifyEventSubscription -> () #

Eq ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Hashable ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

type AWSResponse ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

type Rep ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

type Rep ModifyEventSubscription = D1 ('MetaData "ModifyEventSubscription" "Amazonka.DocumentDB.ModifyEventSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyEventSubscription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "eventCategories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subscriptionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newModifyEventSubscription Source #

Create a value of ModifyEventSubscription 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:

ModifyEventSubscription, modifyEventSubscription_enabled - A Boolean value; set to true to activate the subscription.

ModifyEventSubscription, modifyEventSubscription_eventCategories - A list of event categories for a SourceType that you want to subscribe to.

ModifyEventSubscription, modifyEventSubscription_snsTopicArn - The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

ModifyEventSubscription, modifyEventSubscription_sourceType - The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-parameter-group, db-security-group

$sel:subscriptionName:ModifyEventSubscription', modifyEventSubscription_subscriptionName - The name of the Amazon DocumentDB event notification subscription.

data ModifyEventSubscriptionResponse Source #

See: newModifyEventSubscriptionResponse smart constructor.

Instances

Instances details
Generic ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Associated Types

type Rep ModifyEventSubscriptionResponse :: Type -> Type #

Read ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Show ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

NFData ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Eq ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

type Rep ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyEventSubscription

type Rep ModifyEventSubscriptionResponse = D1 ('MetaData "ModifyEventSubscriptionResponse" "Amazonka.DocumentDB.ModifyEventSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyEventSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyEventSubscriptionResponse Source #

Create a value of ModifyEventSubscriptionResponse 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:eventSubscription:ModifyEventSubscriptionResponse', modifyEventSubscriptionResponse_eventSubscription - Undocumented member.

$sel:httpStatus:ModifyEventSubscriptionResponse', modifyEventSubscriptionResponse_httpStatus - The response's http status code.

ModifyGlobalCluster

data ModifyGlobalCluster Source #

Represents the input to ModifyGlobalCluster.

See: newModifyGlobalCluster smart constructor.

Instances

Instances details
ToHeaders ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

ToPath ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

ToQuery ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

AWSRequest ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Associated Types

type AWSResponse ModifyGlobalCluster #

Generic ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Associated Types

type Rep ModifyGlobalCluster :: Type -> Type #

Read ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Show ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

NFData ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Methods

rnf :: ModifyGlobalCluster -> () #

Eq ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Hashable ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

type AWSResponse ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

type Rep ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

type Rep ModifyGlobalCluster = D1 ('MetaData "ModifyGlobalCluster" "Amazonka.DocumentDB.ModifyGlobalCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyGlobalCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "newGlobalClusterIdentifier'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newModifyGlobalCluster Source #

Create a value of ModifyGlobalCluster 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:

ModifyGlobalCluster, modifyGlobalCluster_deletionProtection - Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.

$sel:newGlobalClusterIdentifier':ModifyGlobalCluster', modifyGlobalCluster_newGlobalClusterIdentifier - The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

  • Must contain from 1 to 63 letters, numbers, or hyphens

    The first character must be a letter

    Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

ModifyGlobalCluster, modifyGlobalCluster_globalClusterIdentifier - The identifier for the global cluster being modified. This parameter isn't case-sensitive.

Constraints:

  • Must match the identifier of an existing global cluster.

data ModifyGlobalClusterResponse Source #

See: newModifyGlobalClusterResponse smart constructor.

Instances

Instances details
Generic ModifyGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Associated Types

type Rep ModifyGlobalClusterResponse :: Type -> Type #

Read ModifyGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Show ModifyGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

NFData ModifyGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Eq ModifyGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

type Rep ModifyGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

type Rep ModifyGlobalClusterResponse = D1 ('MetaData "ModifyGlobalClusterResponse" "Amazonka.DocumentDB.ModifyGlobalCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyGlobalClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GlobalCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyGlobalClusterResponse Source #

Create a value of ModifyGlobalClusterResponse 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:globalCluster:ModifyGlobalClusterResponse', modifyGlobalClusterResponse_globalCluster - Undocumented member.

$sel:httpStatus:ModifyGlobalClusterResponse', modifyGlobalClusterResponse_httpStatus - The response's http status code.

RebootDBInstance

data RebootDBInstance Source #

Represents the input to RebootDBInstance.

See: newRebootDBInstance smart constructor.

Instances

Instances details
ToHeaders RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

ToPath RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

ToQuery RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

AWSRequest RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Associated Types

type AWSResponse RebootDBInstance #

Generic RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Associated Types

type Rep RebootDBInstance :: Type -> Type #

Read RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Show RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

NFData RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

rnf :: RebootDBInstance -> () #

Eq RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Hashable RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

type AWSResponse RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

type Rep RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

type Rep RebootDBInstance = D1 ('MetaData "RebootDBInstance" "Amazonka.DocumentDB.RebootDBInstance" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RebootDBInstance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forceFailover") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newRebootDBInstance Source #

Create a value of RebootDBInstance 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:forceFailover:RebootDBInstance', rebootDBInstance_forceFailover - When true, the reboot is conducted through a Multi-AZ failover.

Constraint: You can't specify true if the instance is not configured for Multi-AZ.

RebootDBInstance, rebootDBInstance_dbInstanceIdentifier - The instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

data RebootDBInstanceResponse Source #

See: newRebootDBInstanceResponse smart constructor.

Instances

Instances details
Generic RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Associated Types

type Rep RebootDBInstanceResponse :: Type -> Type #

Read RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Show RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

NFData RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Eq RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

type Rep RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

type Rep RebootDBInstanceResponse = D1 ('MetaData "RebootDBInstanceResponse" "Amazonka.DocumentDB.RebootDBInstance" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RebootDBInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRebootDBInstanceResponse Source #

Create a value of RebootDBInstanceResponse 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:dbInstance:RebootDBInstanceResponse', rebootDBInstanceResponse_dbInstance - Undocumented member.

$sel:httpStatus:RebootDBInstanceResponse', rebootDBInstanceResponse_httpStatus - The response's http status code.

RemoveFromGlobalCluster

data RemoveFromGlobalCluster Source #

Represents the input to RemoveFromGlobalCluster.

See: newRemoveFromGlobalCluster smart constructor.

Instances

Instances details
ToHeaders RemoveFromGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

ToPath RemoveFromGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

ToQuery RemoveFromGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

AWSRequest RemoveFromGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

Generic RemoveFromGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

Associated Types

type Rep RemoveFromGlobalCluster :: Type -> Type #

Read RemoveFromGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

Show RemoveFromGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

NFData RemoveFromGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

Methods

rnf :: RemoveFromGlobalCluster -> () #

Eq RemoveFromGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

Hashable RemoveFromGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

type AWSResponse RemoveFromGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

type Rep RemoveFromGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

type Rep RemoveFromGlobalCluster = D1 ('MetaData "RemoveFromGlobalCluster" "Amazonka.DocumentDB.RemoveFromGlobalCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RemoveFromGlobalCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newRemoveFromGlobalCluster Source #

Create a value of RemoveFromGlobalCluster 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:

RemoveFromGlobalCluster, removeFromGlobalCluster_globalClusterIdentifier - The cluster identifier to detach from the Amazon DocumentDB global cluster.

RemoveFromGlobalCluster, removeFromGlobalCluster_dbClusterIdentifier - The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster.

data RemoveFromGlobalClusterResponse Source #

See: newRemoveFromGlobalClusterResponse smart constructor.

Instances

Instances details
Generic RemoveFromGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

Associated Types

type Rep RemoveFromGlobalClusterResponse :: Type -> Type #

Read RemoveFromGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

Show RemoveFromGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

NFData RemoveFromGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

Eq RemoveFromGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

type Rep RemoveFromGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveFromGlobalCluster

type Rep RemoveFromGlobalClusterResponse = D1 ('MetaData "RemoveFromGlobalClusterResponse" "Amazonka.DocumentDB.RemoveFromGlobalCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RemoveFromGlobalClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GlobalCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRemoveFromGlobalClusterResponse Source #

Create a value of RemoveFromGlobalClusterResponse 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:globalCluster:RemoveFromGlobalClusterResponse', removeFromGlobalClusterResponse_globalCluster - Undocumented member.

$sel:httpStatus:RemoveFromGlobalClusterResponse', removeFromGlobalClusterResponse_httpStatus - The response's http status code.

RemoveSourceIdentifierFromSubscription

data RemoveSourceIdentifierFromSubscription Source #

Represents the input to RemoveSourceIdentifierFromSubscription.

See: newRemoveSourceIdentifierFromSubscription smart constructor.

Instances

Instances details
ToHeaders RemoveSourceIdentifierFromSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

ToPath RemoveSourceIdentifierFromSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

ToQuery RemoveSourceIdentifierFromSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

AWSRequest RemoveSourceIdentifierFromSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

Generic RemoveSourceIdentifierFromSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

Read RemoveSourceIdentifierFromSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

Show RemoveSourceIdentifierFromSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

NFData RemoveSourceIdentifierFromSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

Eq RemoveSourceIdentifierFromSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

Hashable RemoveSourceIdentifierFromSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

type AWSResponse RemoveSourceIdentifierFromSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

type Rep RemoveSourceIdentifierFromSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

type Rep RemoveSourceIdentifierFromSubscription = D1 ('MetaData "RemoveSourceIdentifierFromSubscription" "Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RemoveSourceIdentifierFromSubscription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subscriptionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newRemoveSourceIdentifierFromSubscription Source #

Create a value of RemoveSourceIdentifierFromSubscription 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:subscriptionName:RemoveSourceIdentifierFromSubscription', removeSourceIdentifierFromSubscription_subscriptionName - The name of the Amazon DocumentDB event notification subscription that you want to remove a source identifier from.

RemoveSourceIdentifierFromSubscription, removeSourceIdentifierFromSubscription_sourceIdentifier - The source identifier to be removed from the subscription, such as the instance identifier for an instance, or the name of a security group.

data RemoveSourceIdentifierFromSubscriptionResponse Source #

Instances

Instances details
Generic RemoveSourceIdentifierFromSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

Read RemoveSourceIdentifierFromSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

Show RemoveSourceIdentifierFromSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

NFData RemoveSourceIdentifierFromSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

Eq RemoveSourceIdentifierFromSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

type Rep RemoveSourceIdentifierFromSubscriptionResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription

type Rep RemoveSourceIdentifierFromSubscriptionResponse = D1 ('MetaData "RemoveSourceIdentifierFromSubscriptionResponse" "Amazonka.DocumentDB.RemoveSourceIdentifierFromSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RemoveSourceIdentifierFromSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

RemoveTagsFromResource

data RemoveTagsFromResource Source #

Represents the input to RemoveTagsFromResource.

See: newRemoveTagsFromResource smart constructor.

Instances

Instances details
ToHeaders RemoveTagsFromResource Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

ToPath RemoveTagsFromResource Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

ToQuery RemoveTagsFromResource Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

AWSRequest RemoveTagsFromResource Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

Associated Types

type AWSResponse RemoveTagsFromResource #

Generic RemoveTagsFromResource Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

Associated Types

type Rep RemoveTagsFromResource :: Type -> Type #

Read RemoveTagsFromResource Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

Show RemoveTagsFromResource Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

NFData RemoveTagsFromResource Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

Methods

rnf :: RemoveTagsFromResource -> () #

Eq RemoveTagsFromResource Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

Hashable RemoveTagsFromResource Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

type AWSResponse RemoveTagsFromResource Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

type Rep RemoveTagsFromResource Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

type Rep RemoveTagsFromResource = D1 ('MetaData "RemoveTagsFromResource" "Amazonka.DocumentDB.RemoveTagsFromResource" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RemoveTagsFromResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newRemoveTagsFromResource Source #

Create a value of RemoveTagsFromResource 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:resourceName:RemoveTagsFromResource', removeTagsFromResource_resourceName - The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).

$sel:tagKeys:RemoveTagsFromResource', removeTagsFromResource_tagKeys - The tag key (name) of the tag to be removed.

data RemoveTagsFromResourceResponse Source #

See: newRemoveTagsFromResourceResponse smart constructor.

Instances

Instances details
Generic RemoveTagsFromResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

Associated Types

type Rep RemoveTagsFromResourceResponse :: Type -> Type #

Read RemoveTagsFromResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

Show RemoveTagsFromResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

NFData RemoveTagsFromResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

Eq RemoveTagsFromResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

type Rep RemoveTagsFromResourceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RemoveTagsFromResource

type Rep RemoveTagsFromResourceResponse = D1 ('MetaData "RemoveTagsFromResourceResponse" "Amazonka.DocumentDB.RemoveTagsFromResource" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RemoveTagsFromResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newRemoveTagsFromResourceResponse :: RemoveTagsFromResourceResponse Source #

Create a value of RemoveTagsFromResourceResponse with all optional fields omitted.

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

ResetDBClusterParameterGroup

data ResetDBClusterParameterGroup Source #

Represents the input to ResetDBClusterParameterGroup.

See: newResetDBClusterParameterGroup smart constructor.

Instances

Instances details
ToHeaders ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

ToPath ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

ToQuery ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

AWSRequest ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Generic ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Associated Types

type Rep ResetDBClusterParameterGroup :: Type -> Type #

Read ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Show ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

NFData ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Eq ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Hashable ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

type AWSResponse ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

type Rep ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

type Rep ResetDBClusterParameterGroup = D1 ('MetaData "ResetDBClusterParameterGroup" "Amazonka.DocumentDB.ResetDBClusterParameterGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ResetDBClusterParameterGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])) :*: (S1 ('MetaSel ('Just "resetAllParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newResetDBClusterParameterGroup Source #

Create a value of ResetDBClusterParameterGroup 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:

ResetDBClusterParameterGroup, resetDBClusterParameterGroup_parameters - A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

$sel:resetAllParameters:ResetDBClusterParameterGroup', resetDBClusterParameterGroup_resetAllParameters - A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

ResetDBClusterParameterGroup, resetDBClusterParameterGroup_dbClusterParameterGroupName - The name of the cluster parameter group to reset.

data DBClusterParameterGroupNameMessage Source #

Contains the name of a cluster parameter group.

See: newDBClusterParameterGroupNameMessage smart constructor.

Instances

Instances details
FromXML DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Generic DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Associated Types

type Rep DBClusterParameterGroupNameMessage :: Type -> Type #

Read DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Show DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

NFData DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Eq DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Hashable DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

type Rep DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

type Rep DBClusterParameterGroupNameMessage = D1 ('MetaData "DBClusterParameterGroupNameMessage" "Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 a cluster parameter group.

Constraints:

  • Must be from 1 to 255 letters or numbers.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

RestoreDBClusterFromSnapshot

data RestoreDBClusterFromSnapshot Source #

Represents the input to RestoreDBClusterFromSnapshot.

See: newRestoreDBClusterFromSnapshot smart constructor.

Instances

Instances details
ToHeaders RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

ToPath RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

ToQuery RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

AWSRequest RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

Generic RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

Associated Types

type Rep RestoreDBClusterFromSnapshot :: Type -> Type #

Read RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

Show RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

NFData RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

Eq RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

Hashable RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

type AWSResponse RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

type Rep RestoreDBClusterFromSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

type Rep RestoreDBClusterFromSnapshot = D1 ('MetaData "RestoreDBClusterFromSnapshot" "Amazonka.DocumentDB.RestoreDBClusterFromSnapshot" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RestoreDBClusterFromSnapshot'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "enableCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "snapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newRestoreDBClusterFromSnapshot Source #

Create a value of RestoreDBClusterFromSnapshot 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:

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_availabilityZones - Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_dbSubnetGroupName - The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_deletionProtection - Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

$sel:enableCloudwatchLogsExports:RestoreDBClusterFromSnapshot', restoreDBClusterFromSnapshot_enableCloudwatchLogsExports - A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_engineVersion - The version of the database engine to use for the new cluster.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_kmsKeyId - The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.
  • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_port - The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

$sel:tags:RestoreDBClusterFromSnapshot', restoreDBClusterFromSnapshot_tags - The tags to be assigned to the restored cluster.

$sel:vpcSecurityGroupIds:RestoreDBClusterFromSnapshot', restoreDBClusterFromSnapshot_vpcSecurityGroupIds - A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_dbClusterIdentifier - The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

$sel:snapshotIdentifier:RestoreDBClusterFromSnapshot', restoreDBClusterFromSnapshot_snapshotIdentifier - The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

RestoreDBClusterFromSnapshot, restoreDBClusterFromSnapshot_engine - The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

data RestoreDBClusterFromSnapshotResponse Source #

Instances

Instances details
Generic RestoreDBClusterFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

Read RestoreDBClusterFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

Show RestoreDBClusterFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

NFData RestoreDBClusterFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

Eq RestoreDBClusterFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

type Rep RestoreDBClusterFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterFromSnapshot

type Rep RestoreDBClusterFromSnapshotResponse = D1 ('MetaData "RestoreDBClusterFromSnapshotResponse" "Amazonka.DocumentDB.RestoreDBClusterFromSnapshot" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RestoreDBClusterFromSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRestoreDBClusterFromSnapshotResponse Source #

Create a value of RestoreDBClusterFromSnapshotResponse 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:dbCluster:RestoreDBClusterFromSnapshotResponse', restoreDBClusterFromSnapshotResponse_dbCluster - Undocumented member.

$sel:httpStatus:RestoreDBClusterFromSnapshotResponse', restoreDBClusterFromSnapshotResponse_httpStatus - The response's http status code.

RestoreDBClusterToPointInTime

data RestoreDBClusterToPointInTime Source #

Represents the input to RestoreDBClusterToPointInTime.

See: newRestoreDBClusterToPointInTime smart constructor.

Instances

Instances details
ToHeaders RestoreDBClusterToPointInTime Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

ToPath RestoreDBClusterToPointInTime Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

ToQuery RestoreDBClusterToPointInTime Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

AWSRequest RestoreDBClusterToPointInTime Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

Generic RestoreDBClusterToPointInTime Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

Associated Types

type Rep RestoreDBClusterToPointInTime :: Type -> Type #

Read RestoreDBClusterToPointInTime Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

Show RestoreDBClusterToPointInTime Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

NFData RestoreDBClusterToPointInTime Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

Eq RestoreDBClusterToPointInTime Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

Hashable RestoreDBClusterToPointInTime Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

type AWSResponse RestoreDBClusterToPointInTime Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

type Rep RestoreDBClusterToPointInTime Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

type Rep RestoreDBClusterToPointInTime = D1 ('MetaData "RestoreDBClusterToPointInTime" "Amazonka.DocumentDB.RestoreDBClusterToPointInTime" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RestoreDBClusterToPointInTime'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "enableCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "restoreToTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))) :*: ((S1 ('MetaSel ('Just "restoreType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "useLatestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sourceDBClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newRestoreDBClusterToPointInTime Source #

Create a value of RestoreDBClusterToPointInTime 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:

RestoreDBClusterToPointInTime, restoreDBClusterToPointInTime_dbSubnetGroupName - The subnet group name to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

RestoreDBClusterToPointInTime, restoreDBClusterToPointInTime_deletionProtection - Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

$sel:enableCloudwatchLogsExports:RestoreDBClusterToPointInTime', restoreDBClusterToPointInTime_enableCloudwatchLogsExports - A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

RestoreDBClusterToPointInTime, restoreDBClusterToPointInTime_kmsKeyId - The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.
  • If the cluster is not encrypted, then the restored cluster is not encrypted.

If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

RestoreDBClusterToPointInTime, restoreDBClusterToPointInTime_port - The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The default port for the engine.

$sel:restoreToTime:RestoreDBClusterToPointInTime', restoreDBClusterToPointInTime_restoreToTime - The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

  • Must be before the latest restorable time for the instance.
  • Must be specified if the UseLatestRestorableTime parameter is not provided.
  • Cannot be specified if the UseLatestRestorableTime parameter is true.
  • Cannot be specified if the RestoreType parameter is copy-on-write.

Example: 2015-03-07T23:45:00Z

$sel:restoreType:RestoreDBClusterToPointInTime', restoreDBClusterToPointInTime_restoreType - The type of restore to be performed. You can specify one of the following values:

  • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
  • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

$sel:tags:RestoreDBClusterToPointInTime', restoreDBClusterToPointInTime_tags - The tags to be assigned to the restored cluster.

$sel:useLatestRestorableTime:RestoreDBClusterToPointInTime', restoreDBClusterToPointInTime_useLatestRestorableTime - A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

$sel:vpcSecurityGroupIds:RestoreDBClusterToPointInTime', restoreDBClusterToPointInTime_vpcSecurityGroupIds - A list of VPC security groups that the new cluster belongs to.

RestoreDBClusterToPointInTime, restoreDBClusterToPointInTime_dbClusterIdentifier - The name of the new cluster to be created.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

$sel:sourceDBClusterIdentifier:RestoreDBClusterToPointInTime', restoreDBClusterToPointInTime_sourceDBClusterIdentifier - The identifier of the source cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

data RestoreDBClusterToPointInTimeResponse Source #

Instances

Instances details
Generic RestoreDBClusterToPointInTimeResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

Read RestoreDBClusterToPointInTimeResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

Show RestoreDBClusterToPointInTimeResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

NFData RestoreDBClusterToPointInTimeResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

Eq RestoreDBClusterToPointInTimeResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

type Rep RestoreDBClusterToPointInTimeResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RestoreDBClusterToPointInTime

type Rep RestoreDBClusterToPointInTimeResponse = D1 ('MetaData "RestoreDBClusterToPointInTimeResponse" "Amazonka.DocumentDB.RestoreDBClusterToPointInTime" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RestoreDBClusterToPointInTimeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRestoreDBClusterToPointInTimeResponse Source #

Create a value of RestoreDBClusterToPointInTimeResponse 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:dbCluster:RestoreDBClusterToPointInTimeResponse', restoreDBClusterToPointInTimeResponse_dbCluster - Undocumented member.

$sel:httpStatus:RestoreDBClusterToPointInTimeResponse', restoreDBClusterToPointInTimeResponse_httpStatus - The response's http status code.

StartDBCluster

data StartDBCluster Source #

See: newStartDBCluster smart constructor.

Constructors

StartDBCluster' Text 

Instances

Instances details
ToHeaders StartDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

ToPath StartDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

ToQuery StartDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

AWSRequest StartDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

Associated Types

type AWSResponse StartDBCluster #

Generic StartDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

Associated Types

type Rep StartDBCluster :: Type -> Type #

Read StartDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

Show StartDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

NFData StartDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

Methods

rnf :: StartDBCluster -> () #

Eq StartDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

Hashable StartDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

type AWSResponse StartDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

type Rep StartDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

type Rep StartDBCluster = D1 ('MetaData "StartDBCluster" "Amazonka.DocumentDB.StartDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "StartDBCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartDBCluster Source #

Create a value of StartDBCluster 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:

StartDBCluster, startDBCluster_dbClusterIdentifier - The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52

data StartDBClusterResponse Source #

See: newStartDBClusterResponse smart constructor.

Instances

Instances details
Generic StartDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

Associated Types

type Rep StartDBClusterResponse :: Type -> Type #

Read StartDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

Show StartDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

NFData StartDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

Methods

rnf :: StartDBClusterResponse -> () #

Eq StartDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

type Rep StartDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.StartDBCluster

type Rep StartDBClusterResponse = D1 ('MetaData "StartDBClusterResponse" "Amazonka.DocumentDB.StartDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "StartDBClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartDBClusterResponse Source #

Create a value of StartDBClusterResponse 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:dbCluster:StartDBClusterResponse', startDBClusterResponse_dbCluster - Undocumented member.

$sel:httpStatus:StartDBClusterResponse', startDBClusterResponse_httpStatus - The response's http status code.

StopDBCluster

data StopDBCluster Source #

See: newStopDBCluster smart constructor.

Constructors

StopDBCluster' Text 

Instances

Instances details
ToHeaders StopDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

ToPath StopDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

ToQuery StopDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

AWSRequest StopDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

Associated Types

type AWSResponse StopDBCluster #

Generic StopDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

Associated Types

type Rep StopDBCluster :: Type -> Type #

Read StopDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

Show StopDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

NFData StopDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

rnf :: StopDBCluster -> () #

Eq StopDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

Hashable StopDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

type AWSResponse StopDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

type Rep StopDBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

type Rep StopDBCluster = D1 ('MetaData "StopDBCluster" "Amazonka.DocumentDB.StopDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "StopDBCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopDBCluster Source #

Create a value of StopDBCluster 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:

StopDBCluster, stopDBCluster_dbClusterIdentifier - The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

data StopDBClusterResponse Source #

See: newStopDBClusterResponse smart constructor.

Instances

Instances details
Generic StopDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

Associated Types

type Rep StopDBClusterResponse :: Type -> Type #

Read StopDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

Show StopDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

NFData StopDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

Methods

rnf :: StopDBClusterResponse -> () #

Eq StopDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

type Rep StopDBClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.StopDBCluster

type Rep StopDBClusterResponse = D1 ('MetaData "StopDBClusterResponse" "Amazonka.DocumentDB.StopDBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "StopDBClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopDBClusterResponse Source #

Create a value of StopDBClusterResponse 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:dbCluster:StopDBClusterResponse', stopDBClusterResponse_dbCluster - Undocumented member.

$sel:httpStatus:StopDBClusterResponse', stopDBClusterResponse_httpStatus - The response's http status code.

Types

ApplyMethod

newtype ApplyMethod Source #

Constructors

ApplyMethod' 

Instances

Instances details
FromJSON ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

FromJSONKey ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

ToJSON ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

ToJSONKey ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

ToByteString ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

ToHeader ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

ToLog ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

ToQuery ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

FromText ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

ToText ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

Methods

toText :: ApplyMethod -> Text #

FromXML ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

ToXML ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

Methods

toXML :: ApplyMethod -> XML #

Generic ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

Associated Types

type Rep ApplyMethod :: Type -> Type #

Read ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

Show ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

NFData ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

Methods

rnf :: ApplyMethod -> () #

Eq ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

Ord ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

Hashable ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

type Rep ApplyMethod Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ApplyMethod

type Rep ApplyMethod = D1 ('MetaData "ApplyMethod" "Amazonka.DocumentDB.Types.ApplyMethod" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'True) (C1 ('MetaCons "ApplyMethod'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromApplyMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SourceType

newtype SourceType Source #

Constructors

SourceType' 

Fields

Instances

Instances details
FromJSON SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

FromJSONKey SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

ToJSON SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

ToJSONKey SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

ToByteString SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

ToHeader SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

ToLog SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

ToQuery SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

FromText SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

ToText SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

Methods

toText :: SourceType -> Text #

FromXML SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

ToXML SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

Methods

toXML :: SourceType -> XML #

Generic SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

Associated Types

type Rep SourceType :: Type -> Type #

Read SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

Show SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

NFData SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

Methods

rnf :: SourceType -> () #

Eq SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

Ord SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

Hashable SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

type Rep SourceType Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.SourceType

type Rep SourceType = D1 ('MetaData "SourceType" "Amazonka.DocumentDB.Types.SourceType" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'True) (C1 ('MetaCons "SourceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AvailabilityZone

data AvailabilityZone Source #

Information about an Availability Zone.

See: newAvailabilityZone smart constructor.

Constructors

AvailabilityZone' (Maybe Text) 

Instances

Instances details
FromXML AvailabilityZone Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.AvailabilityZone

Generic AvailabilityZone Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.AvailabilityZone

Associated Types

type Rep AvailabilityZone :: Type -> Type #

Read AvailabilityZone Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.AvailabilityZone

Show AvailabilityZone Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.AvailabilityZone

NFData AvailabilityZone Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.AvailabilityZone

Methods

rnf :: AvailabilityZone -> () #

Eq AvailabilityZone Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.AvailabilityZone

Hashable AvailabilityZone Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.AvailabilityZone

type Rep AvailabilityZone Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.AvailabilityZone

type Rep AvailabilityZone = D1 ('MetaData "AvailabilityZone" "Amazonka.DocumentDB.Types.AvailabilityZone" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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.

Certificate

data Certificate Source #

A certificate authority (CA) certificate for an Amazon Web Services account.

See: newCertificate smart constructor.

Instances

Instances details
FromXML Certificate Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Certificate

Generic Certificate Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Certificate

Associated Types

type Rep Certificate :: Type -> Type #

Read Certificate Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Certificate

Show Certificate Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Certificate

NFData Certificate Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Certificate

Methods

rnf :: Certificate -> () #

Eq Certificate Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Certificate

Hashable Certificate Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Certificate

type Rep Certificate Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Certificate

type Rep Certificate = D1 ('MetaData "Certificate" "Amazonka.DocumentDB.Types.Certificate" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 "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.

Example: arn:aws:rds:us-east-1::cert:rds-ca-2019

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

Example: rds-ca-2019

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

Example: CA

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

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

Example: 2019-07-31T17:57:09Z

$sel:validTill:Certificate', certificate_validTill - The date-time after which the certificate is no longer valid.

Example: 2024-07-31T17:57:09Z

CloudwatchLogsExportConfiguration

data CloudwatchLogsExportConfiguration Source #

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

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

See: newCloudwatchLogsExportConfiguration smart constructor.

Instances

Instances details
ToQuery CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration

Generic CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration

Associated Types

type Rep CloudwatchLogsExportConfiguration :: Type -> Type #

Read CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration

Show CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration

NFData CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration

Eq CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration

Hashable CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration

type Rep CloudwatchLogsExportConfiguration Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration

type Rep CloudwatchLogsExportConfiguration = D1 ('MetaData "CloudwatchLogsExportConfiguration" "Amazonka.DocumentDB.Types.CloudwatchLogsExportConfiguration" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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.

DBCluster

data DBCluster Source #

Detailed information about a cluster.

See: newDBCluster smart constructor.

Instances

Instances details
FromXML DBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBCluster

Generic DBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBCluster

Associated Types

type Rep DBCluster :: Type -> Type #

Read DBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBCluster

Show DBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBCluster

NFData DBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBCluster

Methods

rnf :: DBCluster -> () #

Eq DBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBCluster

Hashable DBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBCluster

type Rep DBCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBCluster

type Rep DBCluster = D1 ('MetaData "DBCluster" "Amazonka.DocumentDB.Types.DBCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DBCluster'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "associatedRoles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterRole])) :*: S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "cloneGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "clusterCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "dbClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterMember]))))) :*: (((S1 ('MetaSel ('Just "dbClusterParameterGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbSubnetGroup") '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 "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 "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "latestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :*: ((S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "percentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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 "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 "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: 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:associatedRoles:DBCluster', dbCluster_associatedRoles - Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

$sel:availabilityZones:DBCluster', dbCluster_availabilityZones - Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

$sel:backupRetentionPeriod:DBCluster', dbCluster_backupRetentionPeriod - Specifies the number of days for which automatic snapshots are retained.

$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 cluster was created, in Universal Coordinated Time (UTC).

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

$sel:dbClusterIdentifier:DBCluster', dbCluster_dbClusterIdentifier - Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

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

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

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

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

$sel:deletionProtection:DBCluster', dbCluster_deletionProtection - Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

$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 cluster is configured to export to Amazon CloudWatch Logs.

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

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

$sel:engineVersion:DBCluster', dbCluster_engineVersion - Indicates the database engine version.

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

$sel:kmsKeyId:DBCluster', dbCluster_kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

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

$sel:masterUsername:DBCluster', dbCluster_masterUsername - Contains the master user name for the cluster.

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

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

$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:readReplicaIdentifiers:DBCluster', dbCluster_readReplicaIdentifiers - Contains one or more identifiers of the secondary clusters that are associated with this cluster.

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

If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

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

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

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

$sel:vpcSecurityGroups:DBCluster', dbCluster_vpcSecurityGroups - Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

DBClusterMember

data DBClusterMember Source #

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

See: newDBClusterMember smart constructor.

Instances

Instances details
FromXML DBClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterMember

Generic DBClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterMember

Associated Types

type Rep DBClusterMember :: Type -> Type #

Read DBClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterMember

Show DBClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterMember

NFData DBClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterMember

Methods

rnf :: DBClusterMember -> () #

Eq DBClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterMember

Hashable DBClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterMember

type Rep DBClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterMember

type Rep DBClusterMember = D1 ('MetaData "DBClusterMember" "Amazonka.DocumentDB.Types.DBClusterMember" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 cluster parameter group for this member of the DB cluster.

$sel:dbInstanceIdentifier:DBClusterMember', dbClusterMember_dbInstanceIdentifier - Specifies the instance identifier for this member of the cluster.

$sel:isClusterWriter:DBClusterMember', dbClusterMember_isClusterWriter - A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

$sel:promotionTier:DBClusterMember', dbClusterMember_promotionTier - A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

DBClusterParameterGroup

data DBClusterParameterGroup Source #

Detailed information about a cluster parameter group.

See: newDBClusterParameterGroup smart constructor.

Instances

Instances details
FromXML DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup

Generic DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup

Associated Types

type Rep DBClusterParameterGroup :: Type -> Type #

Read DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup

Show DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup

NFData DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup

Methods

rnf :: DBClusterParameterGroup -> () #

Eq DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup

Hashable DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup

type Rep DBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroup

type Rep DBClusterParameterGroup = D1 ('MetaData "DBClusterParameterGroup" "Amazonka.DocumentDB.Types.DBClusterParameterGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 cluster parameter group.

$sel:dbClusterParameterGroupName:DBClusterParameterGroup', dbClusterParameterGroup_dbClusterParameterGroupName - Provides the name of the cluster parameter group.

$sel:dbParameterGroupFamily:DBClusterParameterGroup', dbClusterParameterGroup_dbParameterGroupFamily - Provides the name of the parameter group family that this cluster parameter group is compatible with.

$sel:description:DBClusterParameterGroup', dbClusterParameterGroup_description - Provides the customer-specified description for this cluster parameter group.

DBClusterParameterGroupNameMessage

data DBClusterParameterGroupNameMessage Source #

Contains the name of a cluster parameter group.

See: newDBClusterParameterGroupNameMessage smart constructor.

Instances

Instances details
FromXML DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Generic DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Associated Types

type Rep DBClusterParameterGroupNameMessage :: Type -> Type #

Read DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Show DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

NFData DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Eq DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Hashable DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

type Rep DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

type Rep DBClusterParameterGroupNameMessage = D1 ('MetaData "DBClusterParameterGroupNameMessage" "Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 a cluster parameter group.

Constraints:

  • Must be from 1 to 255 letters or numbers.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

DBClusterRole

data DBClusterRole Source #

Describes an Identity and Access Management (IAM) role that is associated with a cluster.

See: newDBClusterRole smart constructor.

Constructors

DBClusterRole' (Maybe Text) (Maybe Text) 

Instances

Instances details
FromXML DBClusterRole Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterRole

Generic DBClusterRole Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterRole

Associated Types

type Rep DBClusterRole :: Type -> Type #

Read DBClusterRole Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterRole

Show DBClusterRole Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterRole

NFData DBClusterRole Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterRole

Methods

rnf :: DBClusterRole -> () #

Eq DBClusterRole Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterRole

Hashable DBClusterRole Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterRole

type Rep DBClusterRole Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterRole

type Rep DBClusterRole = D1 ('MetaData "DBClusterRole" "Amazonka.DocumentDB.Types.DBClusterRole" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DBClusterRole'" 'PrefixI 'True) (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:roleArn:DBClusterRole', dbClusterRole_roleArn - The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

$sel:status:DBClusterRole', dbClusterRole_status - Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

  • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
  • PENDING - The IAMrole ARN is being associated with the cluster.
  • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

DBClusterSnapshot

data DBClusterSnapshot Source #

Detailed information about a cluster snapshot.

See: newDBClusterSnapshot smart constructor.

Instances

Instances details
FromXML DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot

Generic DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot

Associated Types

type Rep DBClusterSnapshot :: Type -> Type #

Read DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot

Show DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot

NFData DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot

Methods

rnf :: DBClusterSnapshot -> () #

Eq DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot

Hashable DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot

type Rep DBClusterSnapshot Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot

type Rep DBClusterSnapshot = D1 ('MetaData "DBClusterSnapshot" "Amazonka.DocumentDB.Types.DBClusterSnapshot" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DBClusterSnapshot'" 'PrefixI 'True) ((((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 "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "kmsKeyId") '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 "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:availabilityZones:DBClusterSnapshot', dbClusterSnapshot_availabilityZones - Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

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

$sel:dbClusterIdentifier:DBClusterSnapshot', dbClusterSnapshot_dbClusterIdentifier - Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

$sel:dbClusterSnapshotArn:DBClusterSnapshot', dbClusterSnapshot_dbClusterSnapshotArn - The Amazon Resource Name (ARN) for the cluster snapshot.

$sel:dbClusterSnapshotIdentifier:DBClusterSnapshot', dbClusterSnapshot_dbClusterSnapshotIdentifier - Specifies the identifier for the cluster snapshot.

$sel:engine:DBClusterSnapshot', dbClusterSnapshot_engine - Specifies the name of the database engine.

$sel:engineVersion:DBClusterSnapshot', dbClusterSnapshot_engineVersion - Provides the version of the database engine for this cluster snapshot.

$sel:kmsKeyId:DBClusterSnapshot', dbClusterSnapshot_kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

$sel:masterUsername:DBClusterSnapshot', dbClusterSnapshot_masterUsername - Provides the master user name for the 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 cluster was listening on at the time of the snapshot.

$sel:snapshotCreateTime:DBClusterSnapshot', dbClusterSnapshot_snapshotCreateTime - Provides the time when the snapshot was taken, in UTC.

$sel:snapshotType:DBClusterSnapshot', dbClusterSnapshot_snapshotType - Provides the type of the cluster snapshot.

$sel:sourceDBClusterSnapshotArn:DBClusterSnapshot', dbClusterSnapshot_sourceDBClusterSnapshotArn - If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

$sel:status:DBClusterSnapshot', dbClusterSnapshot_status - Specifies the status of this cluster snapshot.

$sel:storageEncrypted:DBClusterSnapshot', dbClusterSnapshot_storageEncrypted - Specifies whether the cluster snapshot is encrypted.

$sel:vpcId:DBClusterSnapshot', dbClusterSnapshot_vpcId - Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

DBClusterSnapshotAttribute

data DBClusterSnapshotAttribute Source #

Contains the name and values of a manual cluster snapshot attribute.

Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.

See: newDBClusterSnapshotAttribute smart constructor.

Instances

Instances details
FromXML DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute

Generic DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute

Associated Types

type Rep DBClusterSnapshotAttribute :: Type -> Type #

Read DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute

Show DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute

NFData DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute

Eq DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute

Hashable DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute

type Rep DBClusterSnapshotAttribute Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute

type Rep DBClusterSnapshotAttribute = D1 ('MetaData "DBClusterSnapshotAttribute" "Amazonka.DocumentDB.Types.DBClusterSnapshotAttribute" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 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 cluster snapshot.

$sel:attributeValues:DBClusterSnapshotAttribute', dbClusterSnapshotAttribute_attributeValues - The values for the manual 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 cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any Amazon Web Services account to copy or restore.

DBClusterSnapshotAttributesResult

data DBClusterSnapshotAttributesResult Source #

Detailed information about the attributes that are associated with a cluster snapshot.

See: newDBClusterSnapshotAttributesResult smart constructor.

Instances

Instances details
FromXML DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult

Generic DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult

Associated Types

type Rep DBClusterSnapshotAttributesResult :: Type -> Type #

Read DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult

Show DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult

NFData DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult

Eq DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult

Hashable DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult

type Rep DBClusterSnapshotAttributesResult Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult

type Rep DBClusterSnapshotAttributesResult = D1 ('MetaData "DBClusterSnapshotAttributesResult" "Amazonka.DocumentDB.Types.DBClusterSnapshotAttributesResult" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 cluster snapshot.

$sel:dbClusterSnapshotIdentifier:DBClusterSnapshotAttributesResult', dbClusterSnapshotAttributesResult_dbClusterSnapshotIdentifier - The identifier of the cluster snapshot that the attributes apply to.

DBEngineVersion

data DBEngineVersion Source #

Detailed information about an engine version.

See: newDBEngineVersion smart constructor.

Instances

Instances details
FromXML DBEngineVersion Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBEngineVersion

Generic DBEngineVersion Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBEngineVersion

Associated Types

type Rep DBEngineVersion :: Type -> Type #

Read DBEngineVersion Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBEngineVersion

Show DBEngineVersion Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBEngineVersion

NFData DBEngineVersion Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBEngineVersion

Methods

rnf :: DBEngineVersion -> () #

Eq DBEngineVersion Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBEngineVersion

Hashable DBEngineVersion Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBEngineVersion

type Rep DBEngineVersion Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBEngineVersion

type Rep DBEngineVersion = D1 ('MetaData "DBEngineVersion" "Amazonka.DocumentDB.Types.DBEngineVersion" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DBEngineVersion'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dbEngineDescription") '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 "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 "supportsLogExportsToCloudwatchLogs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: 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:dbEngineDescription:DBEngineVersion', dbEngineVersion_dbEngineDescription - The description of the database engine.

$sel:dbEngineVersionDescription:DBEngineVersion', dbEngineVersion_dbEngineVersionDescription - The description of the database engine version.

$sel:dbParameterGroupFamily:DBEngineVersion', dbEngineVersion_dbParameterGroupFamily - The name of the parameter group family for the database engine.

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 Amazon CloudWatch Logs.

$sel:supportsLogExportsToCloudwatchLogs:DBEngineVersion', dbEngineVersion_supportsLogExportsToCloudwatchLogs - A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

$sel:validUpgradeTarget:DBEngineVersion', dbEngineVersion_validUpgradeTarget - A list of engine versions that this database engine version can be upgraded to.

DBInstance

data DBInstance Source #

Detailed information about an instance.

See: newDBInstance smart constructor.

Instances

Instances details
FromXML DBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstance

Generic DBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstance

Associated Types

type Rep DBInstance :: Type -> Type #

Read DBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstance

Show DBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstance

NFData DBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstance

Methods

rnf :: DBInstance -> () #

Eq DBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstance

Hashable DBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstance

type Rep DBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstance

type Rep DBInstance = D1 ('MetaData "DBInstance" "Amazonka.DocumentDB.Types.DBInstance" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DBInstance'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "cACertificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "copyTagsToSnapshot") '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 "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 "dbSubnetGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBSubnetGroup))) :*: (S1 ('MetaSel ('Just "dbiResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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 "instanceCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "latestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "pendingModifiedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PendingModifiedValues))))) :*: ((S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "promotionTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "statusInfos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBInstanceStatusInfo]))) :*: (S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: 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:autoMinorVersionUpgrade:DBInstance', dbInstance_autoMinorVersionUpgrade - Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

$sel:availabilityZone:DBInstance', dbInstance_availabilityZone - Specifies the name of the Availability Zone that the instance is located in.

DBInstance, dbInstance_backupRetentionPeriod - Specifies the number of days for which automatic snapshots are retained.

DBInstance, dbInstance_cACertificateIdentifier - The identifier of the CA certificate for this DB instance.

$sel:copyTagsToSnapshot:DBInstance', dbInstance_copyTagsToSnapshot - A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

$sel:dbClusterIdentifier:DBInstance', dbInstance_dbClusterIdentifier - Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

$sel:dbInstanceArn:DBInstance', dbInstance_dbInstanceArn - The Amazon Resource Name (ARN) for the instance.

DBInstance, dbInstance_dbInstanceClass - Contains the name of the compute and memory capacity class of the instance.

DBInstance, dbInstance_dbInstanceIdentifier - Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

$sel:dbInstanceStatus:DBInstance', dbInstance_dbInstanceStatus - Specifies the current state of this database.

$sel:dbSubnetGroup:DBInstance', dbInstance_dbSubnetGroup - Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

$sel:dbiResourceId:DBInstance', dbInstance_dbiResourceId - The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

$sel:enabledCloudwatchLogsExports:DBInstance', dbInstance_enabledCloudwatchLogsExports - A list of log types that this instance is configured to export to CloudWatch Logs.

$sel:endpoint:DBInstance', dbInstance_endpoint - Specifies the connection endpoint.

$sel:engine:DBInstance', dbInstance_engine - Provides the name of the database engine to be used for this instance.

DBInstance, dbInstance_engineVersion - Indicates the database engine version.

$sel:instanceCreateTime:DBInstance', dbInstance_instanceCreateTime - Provides the date and time that the instance was created.

$sel:kmsKeyId:DBInstance', dbInstance_kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

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

$sel:pendingModifiedValues:DBInstance', dbInstance_pendingModifiedValues - Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

$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).

$sel:promotionTier:DBInstance', dbInstance_promotionTier - A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

$sel:publiclyAccessible:DBInstance', dbInstance_publiclyAccessible - Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

$sel:statusInfos:DBInstance', dbInstance_statusInfos - The status of a read replica. If the instance is not a read replica, this is blank.

$sel:storageEncrypted:DBInstance', dbInstance_storageEncrypted - Specifies whether or not the instance is encrypted.

$sel:vpcSecurityGroups:DBInstance', dbInstance_vpcSecurityGroups - Provides a list of VPC security group elements that the instance belongs to.

DBInstanceStatusInfo

data DBInstanceStatusInfo Source #

Provides a list of status information for an instance.

See: newDBInstanceStatusInfo smart constructor.

Instances

Instances details
FromXML DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo

Generic DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo

Associated Types

type Rep DBInstanceStatusInfo :: Type -> Type #

Read DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo

Show DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo

NFData DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo

Methods

rnf :: DBInstanceStatusInfo -> () #

Eq DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo

Hashable DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo

type Rep DBInstanceStatusInfo Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBInstanceStatusInfo

type Rep DBInstanceStatusInfo = D1 ('MetaData "DBInstanceStatusInfo" "Amazonka.DocumentDB.Types.DBInstanceStatusInfo" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 is not in an error state, this value is blank.

$sel:normal:DBInstanceStatusInfo', dbInstanceStatusInfo_normal - A 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 instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

$sel:statusType:DBInstanceStatusInfo', dbInstanceStatusInfo_statusType - This value is currently "read replication."

DBSubnetGroup

data DBSubnetGroup Source #

Detailed information about a subnet group.

See: newDBSubnetGroup smart constructor.

Instances

Instances details
FromXML DBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBSubnetGroup

Generic DBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBSubnetGroup

Associated Types

type Rep DBSubnetGroup :: Type -> Type #

Read DBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBSubnetGroup

Show DBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBSubnetGroup

NFData DBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBSubnetGroup

Methods

rnf :: DBSubnetGroup -> () #

Eq DBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBSubnetGroup

Hashable DBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBSubnetGroup

type Rep DBSubnetGroup Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.DBSubnetGroup

type Rep DBSubnetGroup = D1 ('MetaData "DBSubnetGroup" "Amazonka.DocumentDB.Types.DBSubnetGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 "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 subnet group.

$sel:dbSubnetGroupName:DBSubnetGroup', dbSubnetGroup_dbSubnetGroupName - The name of the subnet group.

$sel:subnetGroupStatus:DBSubnetGroup', dbSubnetGroup_subnetGroupStatus - Provides the status of the subnet group.

$sel:subnets:DBSubnetGroup', dbSubnetGroup_subnets - Detailed information about one or more subnets within a subnet group.

$sel:vpcId:DBSubnetGroup', dbSubnetGroup_vpcId - Provides the virtual private cloud (VPC) ID of the subnet group.

Endpoint

data Endpoint Source #

Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.

See: newEndpoint smart constructor.

Constructors

Endpoint' (Maybe Text) (Maybe Text) (Maybe Int) 

Instances

Instances details
FromXML Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

Generic Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.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.DocumentDB.Types.Endpoint

Show Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

NFData Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

Methods

rnf :: Endpoint -> () #

Eq Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

Hashable Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

Methods

hashWithSalt :: Int -> Endpoint -> Int #

hash :: Endpoint -> Int #

type Rep Endpoint Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Endpoint

type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.DocumentDB.Types.Endpoint" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 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.

EngineDefaults

data EngineDefaults Source #

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

See: newEngineDefaults smart constructor.

Instances

Instances details
FromXML EngineDefaults Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EngineDefaults

Generic EngineDefaults Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EngineDefaults

Associated Types

type Rep EngineDefaults :: Type -> Type #

Read EngineDefaults Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EngineDefaults

Show EngineDefaults Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EngineDefaults

NFData EngineDefaults Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EngineDefaults

Methods

rnf :: EngineDefaults -> () #

Eq EngineDefaults Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EngineDefaults

Hashable EngineDefaults Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EngineDefaults

type Rep EngineDefaults Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EngineDefaults

type Rep EngineDefaults = D1 ('MetaData "EngineDefaults" "Amazonka.DocumentDB.Types.EngineDefaults" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 - The name of the cluster parameter group family to return the engine parameter information for.

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

$sel:parameters:EngineDefaults', engineDefaults_parameters - The parameters of a particular cluster parameter group family.

Event

data Event Source #

Detailed information about an event.

See: newEvent smart constructor.

Instances

Instances details
FromXML Event Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Event

Methods

parseXML :: [Node] -> Either String Event #

Generic Event Source # 
Instance details

Defined in Amazonka.DocumentDB.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.DocumentDB.Types.Event

Show Event Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Event

Methods

showsPrec :: Int -> Event -> ShowS #

show :: Event -> String #

showList :: [Event] -> ShowS #

NFData Event Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Event

Methods

rnf :: Event -> () #

Eq Event Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Event

Methods

(==) :: Event -> Event -> Bool #

(/=) :: Event -> Event -> Bool #

Hashable Event Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Event

Methods

hashWithSalt :: Int -> Event -> Int #

hash :: Event -> Int #

type Rep Event Source # 
Instance details

Defined in Amazonka.DocumentDB.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.

EventCategoriesMap

data EventCategoriesMap Source #

An event source type, accompanied by one or more event category names.

See: newEventCategoriesMap smart constructor.

Instances

Instances details
FromXML EventCategoriesMap Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventCategoriesMap

Generic EventCategoriesMap Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventCategoriesMap

Associated Types

type Rep EventCategoriesMap :: Type -> Type #

Read EventCategoriesMap Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventCategoriesMap

Show EventCategoriesMap Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventCategoriesMap

NFData EventCategoriesMap Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventCategoriesMap

Methods

rnf :: EventCategoriesMap -> () #

Eq EventCategoriesMap Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventCategoriesMap

Hashable EventCategoriesMap Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventCategoriesMap

type Rep EventCategoriesMap Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventCategoriesMap

type Rep EventCategoriesMap = D1 ('MetaData "EventCategoriesMap" "Amazonka.DocumentDB.Types.EventCategoriesMap" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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.

EventSubscription

data EventSubscription Source #

Detailed information about an event to which you have subscribed.

See: newEventSubscription smart constructor.

Instances

Instances details
FromXML EventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventSubscription

Generic EventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventSubscription

Associated Types

type Rep EventSubscription :: Type -> Type #

Read EventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventSubscription

Show EventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventSubscription

NFData EventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventSubscription

Methods

rnf :: EventSubscription -> () #

Eq EventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventSubscription

Hashable EventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventSubscription

type Rep EventSubscription Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.EventSubscription

type Rep EventSubscription = D1 ('MetaData "EventSubscription" "Amazonka.DocumentDB.Types.EventSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 Amazon DocumentDB event notification subscription ID.

$sel:customerAwsId:EventSubscription', eventSubscription_customerAwsId - The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

$sel:enabled:EventSubscription', eventSubscription_enabled - A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

$sel:eventCategoriesList:EventSubscription', eventSubscription_eventCategoriesList - A list of event categories for the Amazon DocumentDB 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 Amazon DocumentDB event notification subscription.

$sel:sourceIdsList:EventSubscription', eventSubscription_sourceIdsList - A list of source IDs for the Amazon DocumentDB event notification subscription.

$sel:sourceType:EventSubscription', eventSubscription_sourceType - The source type for the Amazon DocumentDB event notification subscription.

$sel:status:EventSubscription', eventSubscription_status - The status of the Amazon DocumentDB event notification subscription.

Constraints:

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

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

$sel:subscriptionCreationTime:EventSubscription', eventSubscription_subscriptionCreationTime - The time at which the Amazon DocumentDB event notification subscription was created.

Filter

data Filter Source #

A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

Wildcards are not supported in filters.

See: newFilter smart constructor.

Constructors

Filter' Text [Text] 

Instances

Instances details
ToQuery Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

Generic Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.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.DocumentDB.Types.Filter

Show Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

NFData Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

Methods

rnf :: Filter -> () #

Eq Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

Methods

(==) :: Filter -> Filter -> Bool #

(/=) :: Filter -> Filter -> Bool #

Hashable Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

Methods

hashWithSalt :: Int -> Filter -> Int #

hash :: Filter -> Int #

type Rep Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

type Rep Filter = D1 ('MetaData "Filter" "Amazonka.DocumentDB.Types.Filter" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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.

GlobalCluster

data GlobalCluster Source #

A data type representing an Amazon DocumentDB global cluster.

See: newGlobalCluster smart constructor.

Instances

Instances details
FromXML GlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalCluster

Generic GlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalCluster

Associated Types

type Rep GlobalCluster :: Type -> Type #

Read GlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalCluster

Show GlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalCluster

NFData GlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalCluster

Methods

rnf :: GlobalCluster -> () #

Eq GlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalCluster

Hashable GlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalCluster

type Rep GlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalCluster

type Rep GlobalCluster = D1 ('MetaData "GlobalCluster" "Amazonka.DocumentDB.Types.GlobalCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 "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 cluster.

$sel:deletionProtection:GlobalCluster', globalCluster_deletionProtection - The deletion protection setting for the new global cluster.

$sel:engine:GlobalCluster', globalCluster_engine - The Amazon DocumentDB database engine used by the global cluster.

$sel:engineVersion:GlobalCluster', globalCluster_engineVersion - Indicates the database engine version.

$sel:globalClusterArn:GlobalCluster', globalCluster_globalClusterArn - The Amazon Resource Name (ARN) for the global cluster.

$sel:globalClusterIdentifier:GlobalCluster', globalCluster_globalClusterIdentifier - Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

$sel:globalClusterMembers:GlobalCluster', globalCluster_globalClusterMembers - The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

$sel:globalClusterResourceId:GlobalCluster', globalCluster_globalClusterResourceId - The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

$sel:status:GlobalCluster', globalCluster_status - Specifies the current state of this global cluster.

$sel:storageEncrypted:GlobalCluster', globalCluster_storageEncrypted - The storage encryption setting for the global cluster.

GlobalClusterMember

data GlobalClusterMember Source #

A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.

See: newGlobalClusterMember smart constructor.

Instances

Instances details
FromXML GlobalClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalClusterMember

Generic GlobalClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalClusterMember

Associated Types

type Rep GlobalClusterMember :: Type -> Type #

Read GlobalClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalClusterMember

Show GlobalClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalClusterMember

NFData GlobalClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalClusterMember

Methods

rnf :: GlobalClusterMember -> () #

Eq GlobalClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalClusterMember

Hashable GlobalClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalClusterMember

type Rep GlobalClusterMember Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.GlobalClusterMember

type Rep GlobalClusterMember = D1 ('MetaData "GlobalClusterMember" "Amazonka.DocumentDB.Types.GlobalClusterMember" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "GlobalClusterMember'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (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 Amazon DocumentDB cluster.

$sel:isWriter:GlobalClusterMember', globalClusterMember_isWriter - Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster 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 cluster.

OrderableDBInstanceOption

data OrderableDBInstanceOption Source #

The options that are available for an instance.

See: newOrderableDBInstanceOption smart constructor.

Instances

Instances details
FromXML OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption

Generic OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption

Associated Types

type Rep OrderableDBInstanceOption :: Type -> Type #

Read OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption

Show OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption

NFData OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption

Eq OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption

Hashable OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption

type Rep OrderableDBInstanceOption Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.OrderableDBInstanceOption

type Rep OrderableDBInstanceOption = D1 ('MetaData "OrderableDBInstanceOption" "Amazonka.DocumentDB.Types.OrderableDBInstanceOption" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "OrderableDBInstanceOption'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AvailabilityZone])) :*: (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 "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:availabilityZones:OrderableDBInstanceOption', orderableDBInstanceOption_availabilityZones - A list of Availability Zones for an instance.

$sel:dbInstanceClass:OrderableDBInstanceOption', orderableDBInstanceOption_dbInstanceClass - The instance class for an instance.

$sel:engine:OrderableDBInstanceOption', orderableDBInstanceOption_engine - The engine type of an instance.

$sel:engineVersion:OrderableDBInstanceOption', orderableDBInstanceOption_engineVersion - The engine version of an instance.

$sel:licenseModel:OrderableDBInstanceOption', orderableDBInstanceOption_licenseModel - The license model for an instance.

$sel:vpc:OrderableDBInstanceOption', orderableDBInstanceOption_vpc - Indicates whether an instance is in a virtual private cloud (VPC).

Parameter

data Parameter Source #

Detailed information about an individual parameter.

See: newParameter smart constructor.

Instances

Instances details
ToQuery Parameter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Parameter

FromXML Parameter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Parameter

Generic Parameter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Parameter

Associated Types

type Rep Parameter :: Type -> Type #

Read Parameter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Parameter

Show Parameter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Parameter

NFData Parameter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Parameter

Methods

rnf :: Parameter -> () #

Eq Parameter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Parameter

Hashable Parameter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Parameter

type Rep Parameter Source # 
Instance details

Defined in Amazonka.DocumentDB.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.

PendingCloudwatchLogsExports

data PendingCloudwatchLogsExports Source #

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

See: newPendingCloudwatchLogsExports smart constructor.

Instances

Instances details
FromXML PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports

Generic PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports

Associated Types

type Rep PendingCloudwatchLogsExports :: Type -> Type #

Read PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports

Show PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports

NFData PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports

Eq PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports

Hashable PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports

type Rep PendingCloudwatchLogsExports Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports

type Rep PendingCloudwatchLogsExports = D1 ('MetaData "PendingCloudwatchLogsExports" "Amazonka.DocumentDB.Types.PendingCloudwatchLogsExports" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 Amazon 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.

PendingMaintenanceAction

data PendingMaintenanceAction Source #

Provides information about a pending maintenance action for a resource.

See: newPendingMaintenanceAction smart constructor.

Instances

Instances details
FromXML PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction

Generic PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction

Associated Types

type Rep PendingMaintenanceAction :: Type -> Type #

Read PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction

Show PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction

NFData PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction

Eq PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction

Hashable PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction

type Rep PendingMaintenanceAction Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingMaintenanceAction

type Rep PendingMaintenanceAction = D1 ('MetaData "PendingMaintenanceAction" "Amazonka.DocumentDB.Types.PendingMaintenanceAction" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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.

$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. If this date is specified, any next-maintenance opt-in requests are ignored.

$sel:currentApplyDate:PendingMaintenanceAction', pendingMaintenanceAction_currentApplyDate - The effective date when the pending maintenance action is applied to the resource.

$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. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

$sel:optInStatus:PendingMaintenanceAction', pendingMaintenanceAction_optInStatus - Indicates the type of opt-in request that has been received for the resource.

PendingModifiedValues

data PendingModifiedValues Source #

One or more modified settings for an instance. These modified settings have been requested, but haven't been applied yet.

See: newPendingModifiedValues smart constructor.

Instances

Instances details
FromXML PendingModifiedValues Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingModifiedValues

Generic PendingModifiedValues Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingModifiedValues

Associated Types

type Rep PendingModifiedValues :: Type -> Type #

Read PendingModifiedValues Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingModifiedValues

Show PendingModifiedValues Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingModifiedValues

NFData PendingModifiedValues Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingModifiedValues

Methods

rnf :: PendingModifiedValues -> () #

Eq PendingModifiedValues Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingModifiedValues

Hashable PendingModifiedValues Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingModifiedValues

type Rep PendingModifiedValues Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.PendingModifiedValues

type Rep PendingModifiedValues = D1 ('MetaData "PendingModifiedValues" "Amazonka.DocumentDB.Types.PendingModifiedValues" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "PendingModifiedValues'" '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 "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 "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 "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 - Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

$sel:backupRetentionPeriod:PendingModifiedValues', pendingModifiedValues_backupRetentionPeriod - Specifies the pending number of days for which automated backups are retained.

$sel:cACertificateIdentifier:PendingModifiedValues', pendingModifiedValues_cACertificateIdentifier - Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

$sel:dbInstanceClass:PendingModifiedValues', pendingModifiedValues_dbInstanceClass - Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

$sel:dbInstanceIdentifier:PendingModifiedValues', pendingModifiedValues_dbInstanceIdentifier - Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

$sel:dbSubnetGroupName:PendingModifiedValues', pendingModifiedValues_dbSubnetGroupName - The new subnet group for the instance.

$sel:engineVersion:PendingModifiedValues', pendingModifiedValues_engineVersion - Indicates the database engine version.

$sel:iops:PendingModifiedValues', pendingModifiedValues_iops - Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

$sel:licenseModel:PendingModifiedValues', pendingModifiedValues_licenseModel - The license model for the instance.

Valid values: license-included, bring-your-own-license, general-public-license

$sel:masterUserPassword:PendingModifiedValues', pendingModifiedValues_masterUserPassword - Contains the pending or currently in-progress change of the master credentials for the instance.

$sel:multiAZ:PendingModifiedValues', pendingModifiedValues_multiAZ - Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

$sel:pendingCloudwatchLogsExports:PendingModifiedValues', pendingModifiedValues_pendingCloudwatchLogsExports - A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

$sel:port:PendingModifiedValues', pendingModifiedValues_port - Specifies the pending port for the instance.

$sel:storageType:PendingModifiedValues', pendingModifiedValues_storageType - Specifies the storage type to be associated with the instance.

ResourcePendingMaintenanceActions

data ResourcePendingMaintenanceActions Source #

Represents the output of ApplyPendingMaintenanceAction.

See: newResourcePendingMaintenanceActions smart constructor.

Instances

Instances details
FromXML ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions

Generic ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions

Associated Types

type Rep ResourcePendingMaintenanceActions :: Type -> Type #

Read ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions

Show ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions

NFData ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions

Eq ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions

Hashable ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions

type Rep ResourcePendingMaintenanceActions Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions

type Rep ResourcePendingMaintenanceActions = D1 ('MetaData "ResourcePendingMaintenanceActions" "Amazonka.DocumentDB.Types.ResourcePendingMaintenanceActions" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 Amazon Resource Name (ARN) of the resource that has pending maintenance actions.

Subnet

data Subnet Source #

Detailed information about a subnet.

See: newSubnet smart constructor.

Instances

Instances details
FromXML Subnet Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Subnet

Generic Subnet Source # 
Instance details

Defined in Amazonka.DocumentDB.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.DocumentDB.Types.Subnet

Show Subnet Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Subnet

NFData Subnet Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Subnet

Methods

rnf :: Subnet -> () #

Eq Subnet Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Subnet

Methods

(==) :: Subnet -> Subnet -> Bool #

(/=) :: Subnet -> Subnet -> Bool #

Hashable Subnet Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Subnet

Methods

hashWithSalt :: Int -> Subnet -> Int #

hash :: Subnet -> Int #

type Rep Subnet Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Subnet

type Rep Subnet = D1 ('MetaData "Subnet" "Amazonka.DocumentDB.Types.Subnet" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 "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 - Specifies the Availability Zone for the subnet.

$sel:subnetIdentifier:Subnet', subnet_subnetIdentifier - Specifies the identifier of the subnet.

$sel:subnetStatus:Subnet', subnet_subnetStatus - Specifies the status of the subnet.

Tag

data Tag Source #

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

See: newTag smart constructor.

Constructors

Tag' (Maybe Text) (Maybe Text) 

Instances

Instances details
ToQuery Tag Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Tag

Methods

toQuery :: Tag -> QueryString #

FromXML Tag Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Tag

Methods

parseXML :: [Node] -> Either String Tag #

Generic Tag Source # 
Instance details

Defined in Amazonka.DocumentDB.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.DocumentDB.Types.Tag

Show Tag Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

NFData Tag Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Tag

Methods

rnf :: Tag -> () #

Eq Tag Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Tag

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Hashable Tag Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

type Rep Tag Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Tag

type Rep Tag = D1 ('MetaData "Tag" "Amazonka.DocumentDB.Types.Tag" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 - 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 contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

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

UpgradeTarget

data UpgradeTarget Source #

The version of the database engine that an instance can be upgraded to.

See: newUpgradeTarget smart constructor.

Instances

Instances details
FromXML UpgradeTarget Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.UpgradeTarget

Generic UpgradeTarget Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.UpgradeTarget

Associated Types

type Rep UpgradeTarget :: Type -> Type #

Read UpgradeTarget Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.UpgradeTarget

Show UpgradeTarget Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.UpgradeTarget

NFData UpgradeTarget Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.UpgradeTarget

Methods

rnf :: UpgradeTarget -> () #

Eq UpgradeTarget Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.UpgradeTarget

Hashable UpgradeTarget Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.UpgradeTarget

type Rep UpgradeTarget Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.UpgradeTarget

type Rep UpgradeTarget = D1 ('MetaData "UpgradeTarget" "Amazonka.DocumentDB.Types.UpgradeTarget" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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))))))

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 an 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 a database engine is upgraded to a major version.

VpcSecurityGroupMembership

data VpcSecurityGroupMembership Source #

Used as a response element for queries on virtual private cloud (VPC) security group membership.

See: newVpcSecurityGroupMembership smart constructor.

Instances

Instances details
FromXML VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership

Generic VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership

Associated Types

type Rep VpcSecurityGroupMembership :: Type -> Type #

Read VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership

Show VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership

NFData VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership

Eq VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership

Hashable VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership

type Rep VpcSecurityGroupMembership Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.VpcSecurityGroupMembership

type Rep VpcSecurityGroupMembership = D1 ('MetaData "VpcSecurityGroupMembership" "Amazonka.DocumentDB.Types.VpcSecurityGroupMembership" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 status of the VPC security group.

$sel:vpcSecurityGroupId:VpcSecurityGroupMembership', vpcSecurityGroupMembership_vpcSecurityGroupId - The name of the VPC security group.