String resourceIdentifier
The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.
String applyAction
The pending maintenance action to apply to this resource.
Valid values: system-update, db-upgrade
String 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.
String name
The name of the Availability Zone.
String certificateIdentifier
The unique key that identifies a certificate.
Example: rds-ca-2019
String certificateType
The type of the certificate.
Example: CA
String thumbprint
The thumbprint of the certificate.
Date validFrom
The starting date-time from which the certificate is valid.
Example: 2019-07-31T17:57:09Z
Date validTill
The date-time after which the certificate is no longer valid.
Example: 2024-07-31T17:57:09Z
String certificateArn
The Amazon Resource Name (ARN) for the certificate.
Example: arn:aws:rds:us-east-1::cert:rds-ca-2019
String 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 AWS 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 AWS Region than the copy, specify a valid cluster parameter group
ARN; for example, arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.
String 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
String targetDBClusterParameterGroupDescription
A description for the copied cluster parameter group.
List<E> tags
The tags that are to be assigned to the parameter group.
String sourceDBClusterSnapshotIdentifier
The identifier of the cluster snapshot to copy. This parameter is not case sensitive.
You can't copy an encrypted, shared cluster snapshot from one AWS Region to another.
Constraints:
Must specify a valid system snapshot in the "available" state.
If the source snapshot is in the same AWS Region as the copy, specify a valid snapshot identifier.
If the source snapshot is in a different AWS Region than the copy, specify a valid cluster snapshot ARN.
Example: my-cluster-snapshot1
String 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
String kmsKeyId
The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key.
If you copy an encrypted cluster snapshot from your AWS account, you can specify a value for
KmsKeyId to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for
KmsKeyId, then the copy of the cluster snapshot is encrypted with the same AWS KMS key as the source
cluster snapshot.
If you copy an encrypted cluster snapshot that is shared from another AWS account, then you must specify a value
for KmsKeyId.
To copy an encrypted cluster snapshot to another AWS Region, set KmsKeyId to the AWS KMS key ID that
you want to use to encrypt the copy of the cluster snapshot in the destination Region. AWS KMS encryption keys
are specific to the AWS Region that they are created in, and you can't use encryption keys from one Region in
another Region.
If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error
is returned.
String preSignedUrl
The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action
in the AWS Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl
parameter when copying an encrypted cluster snapshot from another AWS Region.
The presigned URL must be a valid request for the CopyDBSClusterSnapshot API action that can be
executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The presigned URL
request must contain the following parameter values:
KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the cluster snapshot
in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action
that is called in the destination AWS Region, and the action contained in the presigned URL.
DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.
SourceDBClusterSnapshotIdentifier - The cluster snapshot identifier for the encrypted cluster
snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS
Region. For example, if you are copying an encrypted cluster snapshot from the us-west-2 AWS Region, then your
SourceDBClusterSnapshotIdentifier looks like the following example:
arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115.
Boolean 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.
List<E> tags
The tags to be assigned to the cluster snapshot.
String 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.
String dBParameterGroupFamily
The cluster parameter group family name.
String description
The description for the cluster parameter group.
List<E> tags
The tags to be assigned to the cluster parameter group.
List<E> availabilityZones
A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
Integer 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.
String 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
String dBClusterParameterGroupName
The name of the cluster parameter group to associate with this cluster.
List<E> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this cluster.
String dBSubnetGroupName
A subnet group to associate with this cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
String engine
The name of the database engine to be used for this cluster.
Valid values: docdb
String engineVersion
The version number of the database engine to use.
Integer port
The port number on which the instances in the cluster accept connections.
String 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.
String 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.
String 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 AWS 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.
String 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 AWS Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
List<E> tags
The tags to be assigned to the cluster.
Boolean storageEncrypted
Specifies whether the cluster is encrypted.
String kmsKeyId
The AWS KMS key identifier for an encrypted cluster.
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
If an encryption key is not specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the
encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key.
If the StorageEncrypted parameter is true and ReplicationSourceIdentifier
is not specified, Amazon DocumentDB uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
If you create a replica of an encrypted cluster in another AWS Region, you must set KmsKeyId to a
KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS
Region.
List<E> enableCloudwatchLogsExports
A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
Boolean 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.
String 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
String 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
List<E> tags
The tags to be assigned to the cluster snapshot.
String 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
String dBInstanceClass
The compute and memory capacity of the instance; for example, db.r5.large.
String engine
The name of the database engine to be used for this instance.
Valid value: docdb
String availabilityZone
The Amazon EC2 Availability Zone that the instance is created in.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter
is set to true. The specified Availability Zone must be in the same AWS Region as the current
endpoint.
String 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 AWS Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
Boolean autoMinorVersionUpgrade
Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.
Default: true
List<E> tags
The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
String dBClusterIdentifier
The identifier of the cluster that the instance will belong to.
Integer 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
String 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
String dBSubnetGroupDescription
The description for the subnet group.
List<E> subnetIds
The Amazon EC2 subnet IDs for the subnet group.
List<E> tags
The tags to be assigned to the subnet group.
List<E> availabilityZones
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
Integer backupRetentionPeriod
Specifies the number of days for which automatic snapshots are retained.
String dBClusterIdentifier
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
String dBClusterParameterGroup
Specifies the name of the cluster parameter group for the cluster.
String dBSubnetGroup
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
String status
Specifies the current state of this cluster.
String percentProgress
Specifies the progress of the operation as a percentage.
Date earliestRestorableTime
The earliest time to which a database can be restored with point-in-time restore.
String endpoint
Specifies the connection endpoint for the primary instance of the cluster.
String 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.
Boolean multiAZ
Specifies whether the cluster has instances in multiple Availability Zones.
String engine
Provides the name of the database engine to be used for this cluster.
String engineVersion
Indicates the database engine version.
Date latestRestorableTime
Specifies the latest time to which a database can be restored with point-in-time restore.
Integer port
Specifies the port that the database engine is listening on.
String masterUsername
Contains the master user name for the cluster.
String preferredBackupWindow
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod.
String preferredMaintenanceWindow
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
List<E> dBClusterMembers
Provides the list of instances that make up the cluster.
List<E> vpcSecurityGroups
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
String hostedZoneId
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Boolean storageEncrypted
Specifies whether the cluster is encrypted.
String kmsKeyId
If StorageEncrypted is true, the AWS KMS key identifier for the encrypted cluster.
String dbClusterResourceId
The AWS Region-unique, immutable identifier for the cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the cluster is accessed.
String dBClusterArn
The Amazon Resource Name (ARN) for the cluster.
List<E> associatedRoles
Provides a list of the AWS 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 AWS services on your behalf.
Date clusterCreateTime
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
List<E> enabledCloudwatchLogsExports
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
Boolean 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.
String dBInstanceIdentifier
Specifies the instance identifier for this member of the cluster.
Boolean isClusterWriter
A value that is true if the cluster member is the primary instance for the cluster and
false otherwise.
String dBClusterParameterGroupStatus
Specifies the status of the cluster parameter group for this member of the DB cluster.
Integer 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.
String dBClusterParameterGroupName
Provides the name of the cluster parameter group.
String dBParameterGroupFamily
Provides the name of the parameter group family that this cluster parameter group is compatible with.
String description
Provides the customer-specified description for this cluster parameter group.
String dBClusterParameterGroupArn
The Amazon Resource Name (ARN) for the cluster parameter group.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
String status
Describes the state of association between the IAM role and the cluster. The Status property returns
one of the following values:
ACTIVE - The IAM role ARN is associated with the cluster and can be used to access other AWS
services on your behalf.
PENDING - The IAM role ARN is being associated with the DB cluster.
INVALID - The IAM role ARN is associated with the cluster, but the cluster cannot assume the IAM
role to access other AWS services on your behalf.
List<E> availabilityZones
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
String dBClusterSnapshotIdentifier
Specifies the identifier for the cluster snapshot.
String dBClusterIdentifier
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
Date snapshotCreateTime
Provides the time when the snapshot was taken, in UTC.
String engine
Specifies the name of the database engine.
String status
Specifies the status of this cluster snapshot.
Integer port
Specifies the port that the cluster was listening on at the time of the snapshot.
String vpcId
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
Date clusterCreateTime
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
String masterUsername
Provides the master user name for the cluster snapshot.
String engineVersion
Provides the version of the database engine for this cluster snapshot.
String snapshotType
Provides the type of the cluster snapshot.
Integer percentProgress
Specifies the percentage of the estimated data that has been transferred.
Boolean storageEncrypted
Specifies whether the cluster snapshot is encrypted.
String kmsKeyId
If StorageEncrypted is true, the AWS KMS key identifier for the encrypted cluster
snapshot.
String dBClusterSnapshotArn
The Amazon Resource Name (ARN) for the cluster snapshot.
String sourceDBClusterSnapshotArn
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
String attributeName
The name of the manual cluster snapshot attribute.
The attribute named restore refers to the list of AWS accounts that have permission to copy or
restore the manual cluster snapshot.
List<E> 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 AWS 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 AWS account to
copy or restore.
String engine
The name of the database engine.
String engineVersion
The version number of the database engine.
String dBParameterGroupFamily
The name of the parameter group family for the database engine.
String dBEngineDescription
The description of the database engine.
String dBEngineVersionDescription
The description of the database engine version.
List<E> validUpgradeTarget
A list of engine versions that this database engine version can be upgraded to.
List<E> exportableLogTypes
The types of logs that the database engine has available for export to Amazon CloudWatch Logs.
Boolean supportsLogExportsToCloudwatchLogs
A value that indicates whether the engine version supports exporting the log types specified by
ExportableLogTypes to CloudWatch Logs.
String dBInstanceIdentifier
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
String dBInstanceClass
Contains the name of the compute and memory capacity class of the instance.
String engine
Provides the name of the database engine to be used for this instance.
String dBInstanceStatus
Specifies the current state of this database.
Endpoint endpoint
Specifies the connection endpoint.
Date instanceCreateTime
Provides the date and time that the instance was created.
String preferredBackupWindow
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod.
Integer backupRetentionPeriod
Specifies the number of days for which automatic snapshots are retained.
List<E> vpcSecurityGroups
Provides a list of VPC security group elements that the instance belongs to.
String availabilityZone
Specifies the name of the Availability Zone that the instance is located in.
DBSubnetGroup dBSubnetGroup
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
String preferredMaintenanceWindow
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues pendingModifiedValues
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
Date latestRestorableTime
Specifies the latest time to which a database can be restored with point-in-time restore.
String engineVersion
Indicates the database engine version.
Boolean autoMinorVersionUpgrade
Indicates that minor version patches are applied automatically.
Boolean publiclyAccessible
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of
PubliclyAccessible is always false.
List<E> statusInfos
The status of a read replica. If the instance is not a read replica, this is blank.
String dBClusterIdentifier
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
Boolean storageEncrypted
Specifies whether or not the instance is encrypted.
String kmsKeyId
If StorageEncrypted is true, the AWS KMS key identifier for the encrypted instance.
String dbiResourceId
The AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.
String cACertificateIdentifier
The identifier of the CA certificate for this DB instance.
Integer 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.
String dBInstanceArn
The Amazon Resource Name (ARN) for the instance.
List<E> enabledCloudwatchLogsExports
A list of log types that this instance is configured to export to Amazon CloudWatch Logs.
String statusType
This value is currently "read replication."
Boolean normal
A Boolean value that is true if the instance is operating normally, or false if the
instance is in an error state.
String status
Status of the instance. For a StatusType of read replica, the values can be replicating
, error, stopped, or terminated.
String 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.
String dBSubnetGroupName
The name of the subnet group.
String dBSubnetGroupDescription
Provides the description of the subnet group.
String vpcId
Provides the virtual private cloud (VPC) ID of the subnet group.
String subnetGroupStatus
Provides the status of the subnet group.
List<E> subnets
Detailed information about one or more subnets within a subnet group.
String dBSubnetGroupArn
The Amazon Resource Name (ARN) for the DB subnet group.
String 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.
String dBClusterIdentifier
The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.
Constraints:
Must match an existing DBClusterIdentifier.
Boolean 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
String 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.
String dBClusterSnapshotIdentifier
The identifier of the cluster snapshot to delete.
Constraints: Must be the name of an existing cluster snapshot in the available state.
String 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.
String 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
String 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.
List<E> filters
This parameter is not currently supported.
Integer 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
String 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.
List<E> certificates
A list of certificates for this AWS account.
String 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.
String dBClusterParameterGroupName
The name of a specific cluster parameter group to return details for.
Constraints:
If provided, must match the name of an existing DBClusterParameterGroup.
List<E> filters
This parameter is not currently supported.
Integer 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.
String 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.
String 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.
List<E> dBClusterParameterGroups
A list of cluster parameter groups.
String 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.
String source
A value that indicates to return only parameters for a specific source. Parameter sources can be
engine, service, or customer.
List<E> filters
This parameter is not currently supported.
Integer 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.
String 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.
List<E> parameters
Provides a list of parameters for the cluster parameter group.
String 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.
String dBClusterSnapshotIdentifier
The identifier for the cluster snapshot to describe the attributes for.
String 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.
String 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.
String 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
AWS account.
manual - Return all cluster snapshots that you have manually created for your AWS account.
shared - Return all manual cluster snapshots that have been shared to your AWS 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 the
IncludePublic 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.
List<E> filters
This parameter is not currently supported.
Integer 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.
String 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.
Boolean includeShared
Set to true to include shared manual cluster snapshots from other AWS accounts that this AWS account
has been given permission to copy or restore, and otherwise false. The default is false
.
Boolean includePublic
Set to true to include manual cluster snapshots that are public and can be copied or restored by any
AWS account, and otherwise false. The default is false.
String 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.
List<E> 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.
Integer 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.
String 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.
String engine
The database engine to return.
String engineVersion
The database engine version to return.
Example: 5.1.49
String dBParameterGroupFamily
The name of a specific parameter group family to return details for.
Constraints:
If provided, must match an existing DBParameterGroupFamily.
List<E> filters
This parameter is not currently supported.
Integer 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.
String 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.
Boolean defaultOnly
Indicates that only the default version of the specified engine or engine and major version combination is returned.
Boolean 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.
Boolean 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.
String 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.
List<E> dBEngineVersions
Detailed information about one or more engine versions.
String 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.
List<E> 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.
Integer 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.
String 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.
String dBSubnetGroupName
The name of the subnet group to return details for.
List<E> filters
This parameter is not currently supported.
Integer 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.
String 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.
String 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.
List<E> dBSubnetGroups
Detailed information about one or more subnet groups.
String dBParameterGroupFamily
The name of the cluster parameter group family to return the engine parameter information for.
List<E> filters
This parameter is not currently supported.
Integer 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.
String 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.
String 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.
String sourceType
The event source to retrieve events for. If no value is specified, all events are returned.
Date startTime
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
Date endTime
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
Integer duration
The number of minutes to retrieve events for.
Default: 60
List<E> eventCategories
A list of event categories that trigger notifications for an event notification subscription.
List<E> filters
This parameter is not currently supported.
Integer 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.
String 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.
String engine
The name of the engine to retrieve instance options for.
String engineVersion
The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.
String dBInstanceClass
The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.
String licenseModel
The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.
Boolean vpc
The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
List<E> filters
This parameter is not currently supported.
Integer 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.
String 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.
List<E> orderableDBInstanceOptions
The options that are available for a particular orderable instance.
String 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.
String resourceIdentifier
The ARN of a resource to return pending maintenance actions for.
List<E> 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.
String 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.
Integer 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.
List<E> pendingMaintenanceActions
The maintenance actions to be applied.
String 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.
String dBParameterGroupFamily
The name of the cluster parameter group family to return the engine parameter information for.
String 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.
List<E> parameters
The parameters of a particular cluster parameter group family.
String sourceIdentifier
Provides the identifier for the source of the event.
String sourceType
Specifies the source type for this event.
String message
Provides the text of this event.
List<E> eventCategories
Specifies the category for the event.
Date date
Specifies the date and time of the event.
String sourceArn
The Amazon Resource Name (ARN) for the event.
String dBClusterIdentifier
A cluster identifier to force a failover for. This parameter is not case sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
String 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.
String 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.
String 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.
String 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
Boolean 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
Integer 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.
String dBClusterParameterGroupName
The name of the cluster parameter group to use for the cluster.
List<E> vpcSecurityGroupIds
A list of virtual private cloud (VPC) security groups that the cluster will belong to.
Integer 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.
String 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.
String 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 AWS 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.
String 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 AWS Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
CloudwatchLogsExportConfiguration 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.
String engineVersion
The version number of the database engine to which you want to upgrade. Changing this parameter results in an
outage. The change is applied during the next maintenance window unless the ApplyImmediately
parameter is set to true.
Boolean 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.
String dBClusterSnapshotIdentifier
The identifier for the cluster snapshot to modify the attributes for.
String attributeName
The name of the cluster snapshot attribute to modify.
To manage authorization for other AWS accounts to copy or restore a manual cluster snapshot, set this value to
restore.
List<E> valuesToAdd
A list of cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other AWS accounts to copy or restore a manual cluster snapshot, set this list to include one or
more AWS account IDs. To make the manual cluster snapshot restorable by any AWS 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 AWS accounts.
List<E> valuesToRemove
A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other AWS accounts to copy or restore a manual cluster snapshot, set this list to
include one or more AWS account identifiers. To remove authorization for any AWS account to copy or restore the
cluster snapshot, set it to all . If you specify all, an AWS account whose account ID
is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.
String dBInstanceIdentifier
The instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
String dBInstanceClass
The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance
classes are available in all AWS 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.
Boolean 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
String 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.
Boolean autoMinorVersionUpgrade
Indicates that minor version upgrades are applied automatically to the instance during the maintenance window.
Changing this parameter doesn't result in an outage except in the following case, and the change is
asynchronously applied as soon as possible. An outage results if this parameter is set to true
during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled
automatic patching for that engine version.
String 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
String cACertificateIdentifier
Indicates the certificate that needs to be associated with the instance.
Integer 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
String 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
String dBSubnetGroupDescription
The description for the subnet group.
List<E> subnetIds
The Amazon EC2 subnet IDs for the subnet group.
String engine
The engine type of an instance.
String engineVersion
The engine version of an instance.
String dBInstanceClass
The instance class for an instance.
String licenseModel
The license model for an instance.
List<E> availabilityZones
A list of Availability Zones for an instance.
Boolean vpc
Indicates whether an instance is in a virtual private cloud (VPC).
String parameterName
Specifies the name of the parameter.
String parameterValue
Specifies the value of the parameter.
String description
Provides a description of the parameter.
String source
Indicates the source of the parameter value.
String applyType
Specifies the engine-specific parameters type.
String dataType
Specifies the valid data type for the parameter.
String allowedValues
Specifies the valid range of values for the parameter.
Boolean 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.
String minimumEngineVersion
The earliest engine version to which the parameter can apply.
String applyMethod
Indicates when to apply parameter updates.
List<E> logTypesToEnable
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
List<E> logTypesToDisable
Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
String action
The type of pending maintenance action that is available for the resource.
Date 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.
Date 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.
String optInStatus
Indicates the type of opt-in request that has been received for the resource.
Date currentApplyDate
The effective date when the pending maintenance action is applied to the resource.
String description
A description providing more detail about the maintenance action.
String dBInstanceClass
Contains the new DBInstanceClass for the instance that will be applied or is currently being
applied.
Integer allocatedStorage
Contains the new AllocatedStorage size for then instance that will be applied or is currently being
applied.
String masterUserPassword
Contains the pending or currently in-progress change of the master credentials for the instance.
Integer port
Specifies the pending port for the instance.
Integer backupRetentionPeriod
Specifies the pending number of days for which automated backups are retained.
Boolean multiAZ
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
String engineVersion
Indicates the database engine version.
String licenseModel
The license model for the instance.
Valid values: license-included, bring-your-own-license,
general-public-license
Integer iops
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
String dBInstanceIdentifier
Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being
applied.
String storageType
Specifies the storage type to be associated with the instance.
String cACertificateIdentifier
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
String dBSubnetGroupName
The new subnet group for the instance.
PendingCloudwatchLogsExports pendingCloudwatchLogsExports
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
String dBInstanceIdentifier
The instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
Boolean 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.
String dBClusterParameterGroupName
The name of the cluster parameter group to reset.
Boolean 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.
List<E> 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.
String 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.
List<E> availabilityZones
Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
String 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
String 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.
String 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.
String engineVersion
The version of the database engine to use for the new cluster.
Integer 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.
String 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
List<E> vpcSecurityGroupIds
A list of virtual private cloud (VPC) security groups that the new cluster will belong to.
List<E> tags
The tags to be assigned to the restored cluster.
String kmsKeyId
The AWS KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS 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 AWS 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.
List<E> enableCloudwatchLogsExports
A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
Boolean 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.
String 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.
String sourceDBClusterIdentifier
The identifier of the source cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Date 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
Boolean 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.
Integer 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.
String dBSubnetGroupName
The subnet group name to use for the new cluster.
Constraints: If provided, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
List<E> vpcSecurityGroupIds
A list of VPC security groups that the new cluster belongs to.
List<E> tags
The tags to be assigned to the restored cluster.
String kmsKeyId
The AWS KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
You can restore to a new cluster and encrypt the new cluster with an AWS KMS key that is different from the AWS
KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the AWS 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 AWS 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.
List<E> enableCloudwatchLogsExports
A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
Boolean 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.
String dBClusterIdentifier
The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52
String dBClusterIdentifier
The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52
String subnetIdentifier
Specifies the identifier of the subnet.
AvailabilityZone subnetAvailabilityZone
Specifies the Availability Zone for the subnet.
String subnetStatus
Specifies the status of the subnet.
String 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}_.:/=+\\-]*)$").
String 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}_.:/=+\\-]*)$").
String engine
The name of the upgrade target database engine.
String engineVersion
The version number of the upgrade target database engine.
String description
The version of the database engine that an instance can be upgraded to.
Boolean autoUpgrade
A value that indicates whether the target version is applied to any source DB instances that have
AutoMinorVersionUpgrade set to true.
Boolean isMajorVersionUpgrade
A value that indicates whether a database engine is upgraded to a major version.
Copyright © 2020. All rights reserved.