String dBClusterIdentifier
The name of the DB cluster to associate the IAM role with.
String roleArn
The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example
arn:aws:iam::123456789012:role/AuroraAccessRole.
String featureName
The name of the feature for the DB cluster that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion.
String dBInstanceIdentifier
The name of the DB instance to associate the IAM role with.
String roleArn
The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example
arn:aws:iam::123456789012:role/AccessRole.
String featureName
The name of the feature for the DB instance that the IAM role is to be associated with. For the list of supported
feature names, see DBEngineVersion.
String subscriptionName
The name of the RDS event notification subscription you want to add a source identifier to.
String sourceIdentifier
The identifier of the event source to be added.
Constraints:
If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
If the source type is a DB security group, a DBSecurityGroupName must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
String resourceName
The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
SdkInternalList<T> tags
The tags to be assigned to the Amazon RDS resource.
String resourceIdentifier
The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
String applyAction
The pending maintenance action to apply to this resource.
Valid values: system-update, db-upgrade, hardware-maintenance
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 dBSecurityGroupName
The name of the DB security group to add authorization to.
String cIDRIP
The IP range to authorize.
String eC2SecurityGroupName
Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be
provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or
EC2SecurityGroupId must be provided.
String eC2SecurityGroupId
Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be
provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or
EC2SecurityGroupId must be provided.
String eC2SecurityGroupOwnerId
AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName
parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups,
EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId must be provided.
String name
The name of the Availability Zone.
String name
The name of the processor feature. Valid names are coreCount and threadsPerCore.
String defaultValue
The default value for the processor feature of the DB instance class.
String allowedValues
The allowed values for the processor feature of the DB instance class.
String dBClusterIdentifier
The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
Date backtrackTo
The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.
If the specified time is not a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.
Constraints:
Must contain a valid ISO 8601 timestamp.
Can't contain a timestamp set in the future.
Example: 2017-07-08T18:00Z
Boolean force
A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.
Boolean useEarliestTimeOnPointInTimeUnavailable
A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.
String dBClusterIdentifier
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
String backtrackIdentifier
Contains the backtrack identifier.
Date backtrackTo
The timestamp of the time to which the DB cluster was backtracked.
Date backtrackedFrom
The timestamp of the time from which the DB cluster was backtracked.
Date backtrackRequestCreationTime
The timestamp of the time at which the backtrack was requested.
String status
The status of the backtrack. This property returns one of the following values:
applying - The backtrack is currently being applied to or rolled back from the DB cluster.
completed - The backtrack has successfully been applied to or rolled back from the DB cluster.
failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
pending - The backtrack is currently pending application to or rollback from the DB cluster.
String certificateIdentifier
The unique key that identifies a certificate.
String certificateType
The type of the certificate.
String thumbprint
The thumbprint of the certificate.
Date validFrom
The starting date from which the certificate is valid.
Date validTill
The final date that the certificate continues to be valid.
String certificateArn
The Amazon Resource Name (ARN) for the certificate.
SdkInternalList<T> enableLogTypes
The list of log types to enable.
SdkInternalList<T> disableLogTypes
The list of log types to disable.
String sourceDBClusterParameterGroupIdentifier
The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.
Constraints:
Must specify a valid DB cluster parameter group.
If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter
group identifier, for example my-db-cluster-param-group, or a valid ARN.
If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB 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 DB cluster parameter group.
Constraints:
Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster-param-group1
String targetDBClusterParameterGroupDescription
A description for the copied DB cluster parameter group.
SdkInternalList<T> tags
String sourceDBClusterSnapshotIdentifier
The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.
You can't copy an encrypted, shared DB 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 DB snapshot identifier.
If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across AWS Regions in the Amazon Aurora User Guide.
Example: my-cluster-snapshot1
String targetDBClusterSnapshotIdentifier
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-snapshot2
String kmsKeyId
The AWS AWS KMS key ID for an encrypted DB 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 DB cluster snapshot from your AWS 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 DB cluster snapshot is encrypted with the same KMS key as the source
DB cluster snapshot.
If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a
value for KmsKeyId.
To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key
ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption
keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS
Region in another AWS Region.
If you copy an unencrypted DB 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 DB cluster snapshot to copy. The PreSignedUrl parameter
must be used when copying an encrypted DB cluster snapshot from another AWS Region.
The pre-signed 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 pre-signed
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 DB 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 pre-signed URL.
DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB 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 DB 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:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
Boolean copyTags
A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
SdkInternalList<T> tags
String sourceRegion
String sourceDBParameterGroupIdentifier
The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
Constraints:
Must specify a valid DB parameter group.
Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.
String targetDBParameterGroupIdentifier
The identifier for the copied DB parameter group.
Constraints:
Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-db-parameter-group
String targetDBParameterGroupDescription
A description for the copied DB parameter group.
SdkInternalList<T> tags
String sourceDBSnapshotIdentifier
The identifier for the source DB snapshot.
If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For
example, you might specify rds:mysql-instance1-snapshot-20130805.
If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example,
you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and
must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.
Constraints:
Must specify a valid system snapshot in the "available" state.
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
String targetDBSnapshotIdentifier
The identifier for the copy of the snapshot.
Constraints:
Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-db-snapshot
String kmsKeyId
The AWS KMS key ID for an encrypted DB 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 DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.
If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.
If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
SdkInternalList<T> tags
Boolean copyTags
A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.
String preSignedUrl
The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the
source AWS Region that contains the source DB snapshot to copy.
You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the
Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy
an encrypted DB snapshot from another AWS Region by using the AWS CLI.
The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in
the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must
contain the following parameter values:
DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is
the same one where the CopyDBSnapshot action is called that contains this presigned URL.
For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then
you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that
contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the
DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.
KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in
the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is
called in the destination AWS Region, and the action contained in the presigned URL.
SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted 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 DB snapshot from the us-west-2 AWS Region, then your
SourceDBSnapshotIdentifier looks like the following example:
arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
String optionGroupName
The name of an option group to associate with the copy of the snapshot.
Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.
String sourceRegion
String sourceOptionGroupIdentifier
The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
Constraints:
Must specify a valid option group.
If the source option group is in the same AWS Region as the copy, specify a valid option group identifier, for
example my-option-group, or a valid ARN.
If the source option group is in a different AWS Region than the copy, specify a valid option group ARN, for
example arn:aws:rds:us-west-2:123456789012:og:special-options.
String targetOptionGroupIdentifier
The identifier for the copied option group.
Constraints:
Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-option-group
String targetOptionGroupDescription
The description for the copied option group.
SdkInternalList<T> tags
String dBClusterIdentifier
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointIdentifier
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
String endpointType
The type of the endpoint. One of: READER, ANY.
SdkInternalList<T> staticMembers
List of DB instance identifiers that are part of the custom endpoint group.
SdkInternalList<T> excludedMembers
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
String dBClusterEndpointIdentifier
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterIdentifier
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointResourceIdentifier
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
String endpoint
The DNS address of the endpoint.
String status
The current status of the endpoint. One of: creating, available, deleting,
modifying.
String endpointType
The type of the endpoint. One of: READER, WRITER, CUSTOM.
String customEndpointType
The type associated with a custom endpoint. One of: READER, ANY.
SdkInternalList<T> staticMembers
List of DB instance identifiers that are part of the custom endpoint group.
SdkInternalList<T> excludedMembers
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
String dBClusterEndpointArn
The Amazon Resource Name (ARN) for the endpoint.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
Constraints:
Must match the name of an existing DB cluster parameter group.
This value is stored as a lowercase string.
String dBParameterGroupFamily
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
Aurora MySQL
Example: aurora5.6, aurora-mysql5.7
Aurora PostgreSQL
Example: aurora-postgresql9.6
String description
The description for the DB cluster parameter group.
SdkInternalList<T> tags
Tags to assign to the DB cluster parameter group.
SdkInternalList<T> availabilityZones
A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Integer backupRetentionPeriod
The number of days for which automated backups are retained.
Default: 1
Constraints:
Must be a value from 1 to 35
String characterSetName
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
String databaseName
The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
String dBClusterIdentifier
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
String dBClusterParameterGroupName
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted,
default.aurora5.6 is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
SdkInternalList<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB cluster.
String dBSubnetGroupName
A DB subnet group to associate with this DB 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 DB cluster.
Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL
5.7-compatible Aurora), and aurora-postgresql
String engineVersion
The version number of the database engine to use.
Aurora MySQL
Example: 5.6.10a, 5.7.12
Aurora PostgreSQL
Example: 9.6.3
Integer port
The port number on which the instances in the DB cluster accept connections.
Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
String masterUsername
The name of the master user for the DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't 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 "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
String optionGroupName
A value that indicates that the DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
String replicationSourceIdentifier
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
SdkInternalList<T> tags
Tags to assign to the DB cluster.
Boolean storageEncrypted
A value that indicates whether the DB cluster is encrypted.
String kmsKeyId
The AWS KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then 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 ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the
encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.
If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier is not
specified, then Amazon RDS will use 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 Read Replica of an encrypted DB 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 Read Replica in that
AWS Region.
String preSignedUrl
A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called
in the source AWS Region where the DB cluster is replicated from. You only need to specify
PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed
in the source AWS Region that contains the encrypted DB cluster to be copied.
The pre-signed 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 DB cluster in
the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster
action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion - The name of the AWS Region that Aurora Read Replica will be created in.
ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster 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 DB cluster from the us-west-2 AWS Region, then your
ReplicationSourceIdentifier would look like Example:
arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
Long backtrackWindow
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
SdkInternalList<T> enableCloudwatchLogsExports
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
String engineMode
The DB engine mode of the DB cluster, either provisioned, serverless,
parallelquery, or global.
ScalingConfiguration scalingConfiguration
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Boolean deletionProtection
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
String globalClusterIdentifier
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
Boolean copyTagsToSnapshot
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
String sourceRegion
String dBClusterSnapshotIdentifier
The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1-snapshot1
String dBClusterIdentifier
The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
Example: my-cluster1
SdkInternalList<T> tags
The tags to be assigned to the DB cluster snapshot.
String dBInstanceIdentifier
The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
String sourceDBInstanceIdentifier
The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.
Constraints:
Must be the identifier of an existing MySQL, MariaDB, Oracle, or PostgreSQL DB instance.
Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6 or later.
For the limitations of Oracle Read Replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.
Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).
The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.
If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
String dBInstanceClass
The compute and memory capacity of the Read Replica, for example, db.m4.large. Not all DB instance
classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes,
and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
Default: Inherits from the source DB instance.
String availabilityZone
The Availability Zone (AZ) where the Read Replica will be created.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Integer port
The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
Boolean multiAZ
A value that indicates whether the Read Replica is in a Multi-AZ deployment.
You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
Boolean autoMinorVersionUpgrade
A value that indicates whether minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
Default: Inherits from the source DB instance
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
String optionGroupName
The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.
Boolean publiclyAccessible
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
SdkInternalList<T> tags
String dBSubnetGroupName
Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.
Constraints:
Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same AWS Region in which the operation is running.
All Read Replicas in one AWS Region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.
Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.
Example: mySubnetgroup
SdkInternalList<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with the Read Replica.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
String storageType
Specifies the storage type to be associated with the Read Replica.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
Boolean copyTagsToSnapshot
A value that indicates whether to copy all tags from the Read Replica to snapshots of the Read Replica. By default, tags are not copied.
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go
to To
create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a
MonitoringRoleArn value.
String kmsKeyId
The AWS KMS key ID for an encrypted Read Replica. 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 create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.
If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
You can't create an encrypted Read Replica from an unencrypted DB instance.
String preSignedUrl
The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API
action in the source AWS Region that contains the source DB instance.
You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the
Amazon RDS API. You can specify the --source-region option instead of this parameter when you create
an encrypted Read Replica from another AWS Region by using the AWS CLI.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be
executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must
contain the following parameter values:
DestinationRegion - The AWS Region that the encrypted Read Replica is created in. This AWS Region is
the same one where the CreateDBInstanceReadReplica action is called that contains this presigned
URL.
For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the
us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS
Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in
the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set
to the us-east-1 AWS Region.
KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the Read Replica in the
destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action
that is called in the destination AWS Region, and the action contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be
replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For
example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your
SourceDBInstanceIdentifier looks like the following example:
arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora MySQL 5.6 or higher
Boolean enablePerformanceInsights
A value that indicates whether to enable Performance Insights for the Read Replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
String performanceInsightsKMSKeyId
The AWS KMS key identifier for encryption of Performance Insights data. 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 do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS 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.
Integer performanceInsightsRetentionPeriod
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Boolean useDefaultProcessorFeatures
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
Boolean deletionProtection
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
String sourceRegion
String dBName
The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null, the default value
ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName
.
Default: ORCL
Constraints:
Can't be longer than 8 characters
SQL Server
Not applicable. Must be null.
Amazon Aurora
The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't be a word reserved by the specified database engine
String dBInstanceIdentifier
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
Integer allocatedStorage
The amount of storage (in gibibytes) to allocate for the DB instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
String dBInstanceClass
The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance
classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes,
and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
String engine
The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible Aurora)
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
String masterUsername
The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Can't be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Can't be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
String masterUserPassword
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
SdkInternalList<T> dBSecurityGroups
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
SdkInternalList<T> vpcSecurityGroupIds
A list of Amazon EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
String availabilityZone
The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.
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 DB instance is a Multi-AZ
deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.
String dBSubnetGroupName
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
String preferredMaintenanceWindow
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.
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.
String dBParameterGroupName
The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Integer backupRetentionPeriod
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Can't be set to 0 if the DB instance is a source to Read Replicas
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.
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.
Integer port
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535 except for 1434, 3389, 47001,
49152, and 49152 through 49156.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
Boolean multiAZ
A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the
AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
String engineVersion
The version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
MariaDB
See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
See Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
Boolean autoMinorVersionUpgrade
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
String licenseModel
License model information for this DB instance.
Valid values: license-included | bring-your-own-license |
general-public-license
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
Constraints: Must be a multiple between 1 and 50 of the storage amount for the DB instance.
String optionGroupName
Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
String characterSetName
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see
CreateDBCluster.
Boolean publiclyAccessible
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName is not specified, and PubliclyAccessible is not specified, the
following applies:
If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.
If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName is specified, and PubliclyAccessible is not specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
SdkInternalList<T> tags
Tags to assign to the DB instance.
String dBClusterIdentifier
The identifier of the DB cluster that the instance will belong to.
String storageType
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
String tdeCredentialPassword
The password for the given ARN from the key store in order to access the device.
Boolean storageEncrypted
A value that indicates whether the DB instance is encrypted. By default, it is not encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
String kmsKeyId
The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see
CreateDBCluster.
If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS will use 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.
String domain
For an Amazon RDS DB instance that's running Microsoft SQL Server, this parameter specifies the Active Directory directory ID to create the instance in. Amazon RDS uses Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
Boolean 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.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go
to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a
MonitoringRoleArn value.
String domainIAMRoleName
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Integer promotionTier
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
Default: 1
Valid Values: 0 - 15
String timezone
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Boolean enablePerformanceInsights
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
String performanceInsightsKMSKeyId
The AWS KMS key identifier for encryption of Performance Insights data. 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 do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS 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.
Integer performanceInsightsRetentionPeriod
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
SdkInternalList<T> enableCloudwatchLogsExports
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Boolean deletionProtection
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
String dBParameterGroupFamily
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
To list all of the available parameter group families, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
The output contains duplicates.
String description
The description for the DB parameter group.
SdkInternalList<T> tags
Tags to assign to the DB parameter group.
String dBSecurityGroupName
The name for the DB security group. This value is stored as a lowercase string.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Must not be "Default"
Example: mysecuritygroup
String dBSecurityGroupDescription
The description for the DB security group.
SdkInternalList<T> tags
Tags to assign to the DB security group.
String dBSnapshotIdentifier
The identifier for the DB snapshot.
Constraints:
Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
String dBInstanceIdentifier
The identifier of the DB instance that you want to create the snapshot of.
Constraints:
Must match the identifier of an existing DBInstance.
SdkInternalList<T> tags
String dBSubnetGroupName
The name for the DB 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 DB subnet group.
SdkInternalList<T> subnetIds
The EC2 Subnet IDs for the DB subnet group.
SdkInternalList<T> tags
Tags to assign to the DB subnet group.
String subscriptionName
The name of the subscription.
Constraints: The name must be less than 255 characters.
String 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.
String sourceType
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group |
db-security-group | db-snapshot | db-cluster-snapshot
SdkInternalList<T> eventCategories
A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
SdkInternalList<T> 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 supplied, SourceType must also be provided.
If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
If the source type is a DB security group, a DBSecurityGroupName must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
Boolean enabled
A value that indicates whether to activate the subscription. If the event notification subscription is not activated, the subscription is created but not active.
SdkInternalList<T> tags
String globalClusterIdentifier
The cluster identifier of the new global database cluster.
String sourceDBClusterIdentifier
The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.
String engine
Provides the name of the database engine to be used for this DB cluster.
String engineVersion
The engine version of the Aurora global database.
Boolean deletionProtection
The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
String databaseName
The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.
Boolean storageEncrypted
The storage encryption setting for the new global database cluster.
String optionGroupName
Specifies the name of the option group to be created.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: myoptiongroup
String engineName
Specifies the name of the engine that this option group should be associated with.
String majorEngineVersion
Specifies the major version of the engine that this option group should be associated with.
String optionGroupDescription
The description of the option group.
SdkInternalList<T> tags
Tags to assign to the option group.
Integer allocatedStorage
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size
in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage
size is not fixed, but instead automatically adjusts as needed.
SdkInternalList<T> availabilityZones
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
Integer backupRetentionPeriod
Specifies the number of days for which automatic DB snapshots are retained.
String characterSetName
If present, specifies the name of the character set that this cluster is associated with.
String databaseName
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
String dBClusterIdentifier
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
String dBClusterParameterGroup
Specifies the name of the DB cluster parameter group for the DB cluster.
String dBSubnetGroup
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
String status
Specifies the current state of this DB 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 DB cluster.
String readerEndpoint
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
SdkInternalList<T> customEndpoints
Identifies all custom endpoints associated with the cluster.
Boolean multiAZ
Specifies whether the DB cluster has instances in multiple Availability Zones.
String engine
Provides the name of the database engine to be used for this DB 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 username for the DB cluster.
SdkInternalList<T> dBClusterOptionGroupMemberships
Provides the list of option group memberships for this DB 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).
String replicationSourceIdentifier
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
SdkInternalList<T> readReplicaIdentifiers
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
SdkInternalList<T> dBClusterMembers
Provides the list of instances that make up the DB cluster.
SdkInternalList<T> vpcSecurityGroups
Provides a list of VPC security groups that the DB cluster belongs to.
String hostedZoneId
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Boolean storageEncrypted
Specifies whether the DB cluster is encrypted.
String kmsKeyId
If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
String dbClusterResourceId
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
String dBClusterArn
The Amazon Resource Name (ARN) for the DB cluster.
SdkInternalList<T> associatedRoles
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
Boolean iAMDatabaseAuthenticationEnabled
A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
String cloneGroupId
Identifies the clone group to which the DB cluster is associated.
Date clusterCreateTime
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
Date earliestBacktrackTime
The earliest time to which a DB cluster can be backtracked.
Long backtrackWindow
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
Long backtrackConsumedChangeRecords
The number of change records stored for Backtrack.
SdkInternalList<T> enabledCloudwatchLogsExports
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Integer capacity
The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
String engineMode
The DB engine mode of the DB cluster, either provisioned, serverless, or
parallelquery.
ScalingConfigurationInfo scalingConfigurationInfo
Boolean deletionProtection
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
Boolean httpEndpointEnabled
HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
Boolean copyTagsToSnapshot
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
String dBClusterIdentifier
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
String backtrackIdentifier
Contains the backtrack identifier.
Date backtrackTo
The timestamp of the time to which the DB cluster was backtracked.
Date backtrackedFrom
The timestamp of the time from which the DB cluster was backtracked.
Date backtrackRequestCreationTime
The timestamp of the time at which the backtrack was requested.
String status
The status of the backtrack. This property returns one of the following values:
applying - The backtrack is currently being applied to or rolled back from the DB cluster.
completed - The backtrack has successfully been applied to or rolled back from the DB cluster.
failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
pending - The backtrack is currently pending application to or rollback from the DB cluster.
String dBClusterEndpointIdentifier
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterIdentifier
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointResourceIdentifier
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
String endpoint
The DNS address of the endpoint.
String status
The current status of the endpoint. One of: creating, available, deleting,
modifying.
String endpointType
The type of the endpoint. One of: READER, WRITER, CUSTOM.
String customEndpointType
The type associated with a custom endpoint. One of: READER, ANY.
SdkInternalList<T> staticMembers
List of DB instance identifiers that are part of the custom endpoint group.
SdkInternalList<T> excludedMembers
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
String dBClusterEndpointArn
The Amazon Resource Name (ARN) for the endpoint.
String dBInstanceIdentifier
Specifies the instance identifier for this member of the DB cluster.
Boolean isClusterWriter
A value that indicates whehter the cluster member is the primary instance for the DB cluster.
String dBClusterParameterGroupStatus
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
Integer promotionTier
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
String dBClusterParameterGroupName
Provides the name of the DB cluster parameter group.
String dBParameterGroupFamily
Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.
String description
Provides the customer-specified description for this DB cluster parameter group.
String dBClusterParameterGroupArn
The Amazon Resource Name (ARN) for the DB 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 DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other 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 DB cluster, but the DB cluster is unable to assume
the IAM role in order to access other AWS services on your behalf.
String featureName
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.
SdkInternalList<T> availabilityZones
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
String dBClusterSnapshotIdentifier
Specifies the identifier for the DB cluster snapshot.
String dBClusterIdentifier
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
Date snapshotCreateTime
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
String engine
Specifies the name of the database engine.
Integer allocatedStorage
Specifies the allocated storage size in gibibytes (GiB).
String status
Specifies the status of this DB cluster snapshot.
Integer port
Specifies the port that the DB cluster was listening on at the time of the snapshot.
String vpcId
Provides the VPC ID associated with the DB cluster snapshot.
Date clusterCreateTime
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
String masterUsername
Provides the master username for the DB cluster snapshot.
String engineVersion
Provides the version of the database engine for this DB cluster snapshot.
String licenseModel
Provides the license model information for this DB cluster snapshot.
String snapshotType
Provides the type of the DB cluster snapshot.
Integer percentProgress
Specifies the percentage of the estimated data that has been transferred.
Boolean storageEncrypted
Specifies whether the DB cluster snapshot is encrypted.
String kmsKeyId
If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
String dBClusterSnapshotArn
The Amazon Resource Name (ARN) for the DB cluster snapshot.
String sourceDBClusterSnapshotArn
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
Boolean iAMDatabaseAuthenticationEnabled
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
String attributeName
The name of the manual DB cluster snapshot attribute.
The attribute named restore refers to the list of AWS accounts that have permission to copy or
restore the manual DB cluster snapshot. For more information, see the
ModifyDBClusterSnapshotAttribute API action.
SdkInternalList<T> attributeValues
The value(s) for the manual DB cluster snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs
of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of
all is in the list, then the manual DB cluster snapshot is public and available for any AWS account
to copy or restore.
String dBClusterSnapshotIdentifier
The identifier of the manual DB cluster snapshot that the attributes apply to.
SdkInternalList<T> dBClusterSnapshotAttributes
The list of attributes and values for the manual DB cluster snapshot.
String engine
The name of the database engine.
String engineVersion
The version number of the database engine.
String dBParameterGroupFamily
The name of the DB parameter group family for the database engine.
String dBEngineDescription
The description of the database engine.
String dBEngineVersionDescription
The description of the database engine version.
CharacterSet defaultCharacterSet
The default character set for new instances of this engine version, if the CharacterSetName
parameter of the CreateDBInstance API is not specified.
SdkInternalList<T> supportedCharacterSets
A list of the character sets supported by this engine for the CharacterSetName parameter of the
CreateDBInstance action.
SdkInternalList<T> validUpgradeTarget
A list of engine versions that this database engine version can be upgraded to.
SdkInternalList<T> supportedTimezones
A list of the time zones supported by this engine for the Timezone parameter of the
CreateDBInstance action.
SdkInternalList<T> exportableLogTypes
The types of logs that the database engine has available for export to CloudWatch Logs.
Boolean supportsLogExportsToCloudwatchLogs
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
Boolean supportsReadReplica
Indicates whether the database engine version supports Read Replicas.
SdkInternalList<T> supportedEngineModes
A list of the supported DB engine modes.
SdkInternalList<T> supportedFeatureNames
A list of features supported by the DB engine. Supported feature names include the following.
s3Import
String dBInstanceIdentifier
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
String dBInstanceClass
Contains the name of the compute and memory capacity class of the DB instance.
String engine
Provides the name of the database engine to be used for this DB instance.
String dBInstanceStatus
Specifies the current state of this database.
String masterUsername
Contains the master username for the DB instance.
String dBName
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint endpoint
Specifies the connection endpoint.
Integer allocatedStorage
Specifies the allocated storage size specified in gibibytes.
Date instanceCreateTime
Provides the date and time the DB 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 DB snapshots are retained.
SdkInternalList<T> dBSecurityGroups
A list of DB security group elements containing DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.
SdkInternalList<T> vpcSecurityGroups
Provides a list of VPC security group elements that the DB instance belongs to.
SdkInternalList<T> dBParameterGroups
Provides the list of DB parameter groups applied to this DB instance.
String availabilityZone
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup dBSubnetGroup
Specifies information on the subnet group associated with the DB 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 DB instance are pending. This element is only included 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.
Boolean multiAZ
Specifies if the DB instance is a Multi-AZ deployment.
String engineVersion
Indicates the database engine version.
Boolean autoMinorVersionUpgrade
Indicates that minor version patches are applied automatically.
String readReplicaSourceDBInstanceIdentifier
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
SdkInternalList<T> readReplicaDBInstanceIdentifiers
Contains one or more identifiers of the Read Replicas associated with this DB instance.
SdkInternalList<T> readReplicaDBClusterIdentifiers
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a Read Replica. For example, when you create an Aurora Read Replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Currently, each RDS DB instance can have only one Aurora Read Replica.
String licenseModel
License model information for this DB instance.
Integer iops
Specifies the Provisioned IOPS (I/O operations per second) value.
SdkInternalList<T> optionGroupMemberships
Provides the list of option group memberships for this DB instance.
String characterSetName
If present, specifies the name of the character set that this instance is associated with.
String secondaryAvailabilityZone
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
Boolean publiclyAccessible
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
SdkInternalList<T> statusInfos
The status of a Read Replica. If the instance is not a Read Replica, this is blank.
String storageType
Specifies the storage type associated with DB instance.
String tdeCredentialArn
The ARN from the key store with which the instance is associated for TDE encryption.
Integer dbInstancePort
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
String dBClusterIdentifier
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
Boolean storageEncrypted
Specifies whether the DB instance is encrypted.
String kmsKeyId
If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.
String dbiResourceId
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
String cACertificateIdentifier
The identifier of the CA certificate for this DB instance.
SdkInternalList<T> domainMemberships
The Active Directory Domain membership records associated with the DB instance.
Boolean copyTagsToSnapshot
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB
instance has no effect on the DB cluster setting. For more information, see DBCluster.
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
String enhancedMonitoringResourceArn
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
Integer promotionTier
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
String dBInstanceArn
The Amazon Resource Name (ARN) for the DB instance.
String timezone
The time zone of the DB instance. In most cases, the Timezone element is empty.
Timezone content appears only for Microsoft SQL Server DB instances that were created with a time
zone specified.
Boolean iAMDatabaseAuthenticationEnabled
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
Boolean performanceInsightsEnabled
True if Performance Insights is enabled for the DB instance, and otherwise false.
String performanceInsightsKMSKeyId
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
Integer performanceInsightsRetentionPeriod
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
SdkInternalList<T> enabledCloudwatchLogsExports
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Boolean deletionProtection
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
SdkInternalList<T> associatedRoles
The AWS Identity and Access Management (IAM) roles associated with the DB instance.
Endpoint listenerEndpoint
Specifies the listener connection endpoint for SQL Server Always On.
String dBInstanceArn
The Amazon Resource Name (ARN) for the automated backup.
String dbiResourceId
The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
String region
The AWS Region associated with the automated backup.
String dBInstanceIdentifier
The customer id of the instance that is/was associated with the automated backup.
RestoreWindow restoreWindow
Earliest and latest time an instance can be restored to.
Integer allocatedStorage
Specifies the allocated storage size in gibibytes (GiB).
String status
Provides a list of status information for an automated backup:
active - automated backups for current instances
retained - automated backups for deleted instances
creating - automated backups that are waiting for the first automated snapshot to be available.
Integer port
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
String availabilityZone
The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.
String vpcId
Provides the VPC ID associated with the DB instance
Date instanceCreateTime
Provides the date and time that the DB instance was created.
String masterUsername
The license model of an automated backup.
String engine
The name of the database engine for this automated backup.
String engineVersion
The version of the database engine for the automated backup.
String licenseModel
License model information for the automated backup.
Integer iops
The IOPS (I/O operations per second) value for the automated backup.
String optionGroupName
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
String tdeCredentialArn
The ARN from the key store with which the automated backup is associated for TDE encryption.
Boolean encrypted
Specifies whether the automated backup is encrypted.
String storageType
Specifies the storage type associated with the automated backup.
String kmsKeyId
The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
String timezone
The time zone of the automated backup. In most cases, the Timezone element is empty.
Timezone content appears only for Microsoft SQL Server DB instances that were created with a time
zone specified.
Boolean iAMDatabaseAuthenticationEnabled
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
String featureName
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of
supported feature names, see DBEngineVersion.
String status
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other AWS
services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to
assume the IAM role in order to access other AWS services on your behalf.
String statusType
This value is currently "read replication."
Boolean normal
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 DB instance. For a StatusType of Read Replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
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 dBParameterGroupName
Provides the name of the DB parameter group.
String dBParameterGroupFamily
Provides the name of the DB parameter group family that this DB parameter group is compatible with.
String description
Provides the customer-specified description for this DB parameter group.
String dBParameterGroupArn
The Amazon Resource Name (ARN) for the DB parameter group.
String ownerId
Provides the AWS ID of the owner of a specific DB security group.
String dBSecurityGroupName
Specifies the name of the DB security group.
String dBSecurityGroupDescription
Provides the description of the DB security group.
String vpcId
Provides the VpcId of the DB security group.
SdkInternalList<T> eC2SecurityGroups
Contains a list of EC2SecurityGroup elements.
SdkInternalList<T> iPRanges
Contains a list of IPRange elements.
String dBSecurityGroupArn
The Amazon Resource Name (ARN) for the DB security group.
String dBSnapshotIdentifier
Specifies the identifier for the DB snapshot.
String dBInstanceIdentifier
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
Date snapshotCreateTime
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
String engine
Specifies the name of the database engine.
Integer allocatedStorage
Specifies the allocated storage size in gibibytes (GiB).
String status
Specifies the status of this DB snapshot.
Integer port
Specifies the port that the database engine was listening on at the time of the snapshot.
String availabilityZone
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
String vpcId
Provides the VPC ID associated with the DB snapshot.
Date instanceCreateTime
Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
String masterUsername
Provides the master username for the DB snapshot.
String engineVersion
Specifies the version of the database engine.
String licenseModel
License model information for the restored DB instance.
String snapshotType
Provides the type of the DB snapshot.
Integer iops
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
String optionGroupName
Provides the option group name for the DB snapshot.
Integer percentProgress
The percentage of the estimated data that has been transferred.
String sourceRegion
The AWS Region that the DB snapshot was created in or copied from.
String sourceDBSnapshotIdentifier
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.
String storageType
Specifies the storage type associated with DB snapshot.
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
Boolean encrypted
Specifies whether the DB snapshot is encrypted.
String kmsKeyId
If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
String dBSnapshotArn
The Amazon Resource Name (ARN) for the DB snapshot.
String timezone
The time zone of the DB snapshot. In most cases, the Timezone element is empty.
Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were
created with a time zone specified.
Boolean iAMDatabaseAuthenticationEnabled
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
String dbiResourceId
The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
String attributeName
The name of the manual DB snapshot attribute.
The attribute named restore refers to the list of AWS accounts that have permission to copy or
restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API
action.
SdkInternalList<T> attributeValues
The value or values for the manual DB snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs
of the AWS accounts that are authorized to copy or restore the manual DB snapshot. If a value of all
is in the list, then the manual DB snapshot is public and available for any AWS account to copy or restore.
String dBSnapshotIdentifier
The identifier of the manual DB snapshot that the attributes apply to.
SdkInternalList<T> dBSnapshotAttributes
The list of attributes and values for the manual DB snapshot.
String dBSubnetGroupName
The name of the DB subnet group.
String dBSubnetGroupDescription
Provides the description of the DB subnet group.
String vpcId
Provides the VpcId of the DB subnet group.
String subnetGroupStatus
Provides the status of the DB subnet group.
SdkInternalList<T> subnets
Contains a list of Subnet elements.
String dBSubnetGroupArn
The Amazon Resource Name (ARN) for the DB subnet group.
String dBClusterEndpointIdentifier
The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointIdentifier
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterIdentifier
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointResourceIdentifier
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
String endpoint
The DNS address of the endpoint.
String status
The current status of the endpoint. One of: creating, available, deleting,
modifying.
String endpointType
The type of the endpoint. One of: READER, WRITER, CUSTOM.
String customEndpointType
The type associated with a custom endpoint. One of: READER, ANY.
SdkInternalList<T> staticMembers
List of DB instance identifiers that are part of the custom endpoint group.
SdkInternalList<T> excludedMembers
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
String dBClusterEndpointArn
The Amazon Resource Name (ARN) for the endpoint.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
Constraints:
Must be the name of an existing DB cluster parameter group.
You can't delete a default DB cluster parameter group.
Can't be associated with any DB clusters.
String dBClusterIdentifier
The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
Constraints:
Must match an existing DBClusterIdentifier.
Boolean skipFinalSnapshot
A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip is not specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip is not specified, and the DB cluster snapshot is created. By default, this parameter is disabled.
You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is
disabled.
String finalDBSnapshotIdentifier
The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is
disabled.
Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the
SkipFinalShapshot parameter results in an error.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
String dBClusterSnapshotIdentifier
The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the available state.
String dbiResourceId
The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
String dBInstanceIdentifier
The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
Constraints:
Must match the name of an existing DB instance.
Boolean skipFinalSnapshot
A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip is not specified, a DB snapshot is created before the DB instance is deleted. By default, skip is not specified, and the DB snapshot is created.
Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.
Specify skip when deleting a Read Replica.
The FinalDBSnapshotIdentifier parameter must be specified if skip is not specified.
String finalDBSnapshotIdentifier
The DBSnapshotIdentifier of the new DBSnapshot created when the
SkipFinalSnapshot parameter is disabled.
Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Can't be specified when deleting a Read Replica.
Boolean deleteAutomatedBackups
A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
Must be the name of an existing DB parameter group
You can't delete a default DB parameter group
Can't be associated with any DB instances
String dBSecurityGroupName
The name of the DB security group to delete.
You can't delete the default DB security group.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Must not be "Default"
String dBSnapshotIdentifier
The DB snapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
String dBSubnetGroupName
The name of the database subnet group to delete.
You can't delete the default subnet group.
Constraints:
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
String subscriptionName
The name of the RDS event notification subscription you want to delete.
String globalClusterIdentifier
The cluster identifier of the global database cluster being deleted.
String optionGroupName
The name of the option group to be deleted.
You can't delete default option groups.
SdkInternalList<T> accountQuotas
A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the
quota maximum, and a maximum value for the quota.
String certificateIdentifier
The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.
Constraints:
Must match an existing CertificateIdentifier.
SdkInternalList<T> 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.
SdkInternalList<T> certificates
The list of Certificate objects for the AWS account.
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 .
String dBClusterIdentifier
The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
String backtrackIdentifier
If specified, this value is the backtrack identifier of the backtrack to be described.
Constraints:
Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see A Universally Unique Identifier (UUID) URN Namespace.
Example: 123e4567-e89b-12d3-a456-426655440000
SdkInternalList<T> filters
A filter that specifies one or more DB clusters to describe. Supported filters include the following:
db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about
only the backtracks identified by these identifiers.
db-cluster-backtrack-status - Accepts any of the following backtrack status values:
applying
completed
failed
pending
The results list includes information about only the backtracks identified by these values.
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 DescribeDBClusterBacktracks request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
String marker
A pagination token that can be used in a subsequent DescribeDBClusterBacktracks request.
SdkInternalList<T> dBClusterBacktracks
Contains a list of backtracks for the user.
String dBClusterIdentifier
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointIdentifier
The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
SdkInternalList<T> filters
A set of name-value pairs that define which endpoints to include in the output. The filters are specified as
name-value pairs, in the format
Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name
can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type,
db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the
db-cluster-endpoint-type filter can be one or more of: reader, writer,
custom. Values for the db-cluster-endpoint-custom-type filter can be one
or more of: reader, any. Values for the
db-cluster-endpoint-status filter can be one or more of: available,
creating, deleting, modifying.
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 DescribeDBClusterEndpoints 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 DescribeDBClusterEndpoints request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
SdkInternalList<T> dBClusterEndpoints
Contains the details of the endpoints associated with the cluster and matching any filter conditions.
String dBClusterParameterGroupName
The name of a specific DB cluster parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
SdkInternalList<T> 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 DescribeDBClusterParameterGroups 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 DescribeDBClusterParameterGroups request. If
this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
SdkInternalList<T> dBClusterParameterGroups
A list of DB cluster parameter groups.
String dBClusterParameterGroupName
The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
If supplied, 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.
SdkInternalList<T> 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 DescribeDBClusterParameters request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
SdkInternalList<T> parameters
Provides a list of parameters for the DB cluster parameter group.
String marker
An optional pagination token provided by a previous DescribeDBClusterParameters 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 DB cluster snapshot to describe the attributes for.
String dBClusterIdentifier
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in
conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
String dBClusterSnapshotIdentifier
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the
DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
If supplied, 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 DB cluster snapshots to be returned. You can specify one of the following values:
automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my
AWS account.
manual - Return all DB cluster snapshots that have been taken by my AWS account.
shared - Return all manual DB cluster snapshots that have been shared to my AWS account.
public - Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are
returned. You can include shared DB cluster snapshots with these results by enabling the
IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling
the IncludePublic parameter.
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.
SdkInternalList<T> 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 DescribeDBClusterSnapshots request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
Boolean includeShared
A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the
ModifyDBClusterSnapshotAttribute API action.
Boolean includePublic
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
String marker
An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
SdkInternalList<T> dBClusterSnapshots
Provides a list of DB cluster snapshots for the user.
String dBClusterIdentifier
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
If supplied, must match an existing DBClusterIdentifier.
SdkInternalList<T> filters
A filter that specifies one or more DB clusters to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
results list will only include information about the DB 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 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 DescribeDBClusters request. If this parameter is
specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
String marker
A pagination token that can be used in a subsequent DescribeDBClusters request.
SdkInternalList<T> dBClusters
Contains a list of DB clusters for the user.
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 DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DBParameterGroupFamily.
SdkInternalList<T> filters
This parameter is not currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more than the MaxRecords value is
available, a pagination token called a marker is included in the response so that the following results can be
retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
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
A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
Boolean listSupportedCharacterSets
A value that indicates whether to list the supported character sets for each engine version.
If this parameter is enabled 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
A value that indicates whether to list the supported time zones for each engine version.
If this parameter is enabled 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.
SdkInternalList<T> dBEngineVersions
A list of DBEngineVersion elements.
String dbiResourceId
The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.
String dBInstanceIdentifier
(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive.
SdkInternalList<T> filters
A filter that specifies which resources to return based on status.
Supported filters are the following:
status
active - automated backups for current instances
retained - automated backups for deleted instances
creating - automated backups that are waiting for the first automated snapshot to be available
db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs) for DB instances.
The results list includes only information about the DB instance automated backupss identified by these ARNs.
dbi-resource-id - Accepts DB instance resource identifiers and DB Amazon Resource Names (ARNs) for
DB instances. The results list includes only information about the DB instance resources identified by these
ARNs.
Returns all resources by default. The status for each resource is specified in the response.
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.
String marker
The pagination token provided in the previous request. If this parameter is specified the response includes only
records beyond the marker, up to 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 .
SdkInternalList<T> dBInstanceAutomatedBackups
A list of DBInstanceAutomatedBackup instances.
String dBInstanceIdentifier
The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
SdkInternalList<T> filters
A filter that specifies one or more DB instances to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
results list will only include information about the DB instances associated with the DB clusters identified by
these ARNs.
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The
results list will only include information about the DB instances 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 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 DescribeDBInstances 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 .
SdkInternalList<T> dBInstances
A list of DBInstance instances.
String dBInstanceIdentifier
The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
Must match the identifier of an existing DBInstance.
String filenameContains
Filters the available log files for log file names that contain the specified string.
Long fileLastWritten
Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
Long fileSize
Filters the available log files for files larger than the specified size.
SdkInternalList<T> 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.
String marker
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
SdkInternalList<T> describeDBLogFiles
The DB log files returned.
String marker
A pagination token that can be used in a subsequent DescribeDBLogFiles request.
String dBParameterGroupName
The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
SdkInternalList<T> 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 DescribeDBParameterGroups 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.
SdkInternalList<T> dBParameterGroups
A list of DBParameterGroup instances.
String dBParameterGroupName
The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
String source
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
SdkInternalList<T> 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 DescribeDBParameters request. If this parameter
is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
SdkInternalList<T> parameters
A list of Parameter values.
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 dBSecurityGroupName
The name of the DB security group to return details for.
SdkInternalList<T> 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 DescribeDBSecurityGroups 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.
SdkInternalList<T> dBSecurityGroups
A list of DBSecurityGroup instances.
String dBSnapshotIdentifier
The identifier for the DB snapshot to describe the attributes for.
String dBInstanceIdentifier
The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction
with DBSnapshotIdentifier. This parameter is not case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
String dBSnapshotIdentifier
A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with
DBInstanceIdentifier. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
String snapshotType
The type of snapshots to be returned. You can specify one of the following values:
automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS
account.
manual - Return all DB snapshots that have been taken by my AWS account.
shared - Return all manual DB snapshots that have been shared to my AWS account.
public - Return all DB snapshots that have been marked as public.
awsbackup - Return the DB snapshots managed by the AWS Backup service.
For information about AWS Backup, see the AWS Backup Developer Guide.
The awsbackup type does not apply to Aurora.
If you don't specify a SnapshotType value, then both automated and manual snapshots are returned.
Shared and public DB snapshots are not included in the returned results by default. You can include shared
snapshots with these results by enabling the IncludeShared parameter. You can include public
snapshots with these results by enabling the IncludePublic parameter.
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.
SdkInternalList<T> 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 DescribeDBSnapshots request. If this parameter
is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
Boolean includeShared
A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the
ModifyDBSnapshotAttribute API action.
Boolean includePublic
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
String dbiResourceId
A specific DB resource ID to describe.
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.
SdkInternalList<T> dBSnapshots
A list of DBSnapshot instances.
String dBSubnetGroupName
The name of the DB subnet group to return details for.
SdkInternalList<T> 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 DescribeDBSubnetGroups 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.
SdkInternalList<T> dBSubnetGroups
A list of DBSubnetGroup instances.
String dBParameterGroupFamily
The name of the DB cluster parameter group family to return engine parameter information for.
SdkInternalList<T> 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 DescribeEngineDefaultClusterParameters 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 DB parameter group family.
SdkInternalList<T> 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 DescribeEngineDefaultParameters request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
String sourceType
The type of source that is generating the events.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
SdkInternalList<T> filters
This parameter is not currently supported.
SdkInternalList<T> eventCategoriesMapList
A list of EventCategoriesMap data types.
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 supplied, SourceType must also be provided.
If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.
If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.
If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.
If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.
Can't 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. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
Date endTime
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
Integer duration
The number of minutes to retrieve events for.
Default: 60
SdkInternalList<T> eventCategories
A list of event categories that trigger notifications for a event notification subscription.
SdkInternalList<T> 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 DescribeEvents 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 Events request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords .
SdkInternalList<T> events
A list of Event instances.
String subscriptionName
The name of the RDS event notification subscription you want to describe.
SdkInternalList<T> 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 DescribeOrderableDBInstanceOptions 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 DescribeOrderableDBInstanceOptions request. If this parameter
is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
SdkInternalList<T> eventSubscriptionsList
A list of EventSubscriptions data types.
String globalClusterIdentifier
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
If supplied, must match an existing DBClusterIdentifier.
SdkInternalList<T> filters
A filter that specifies one or more global DB clusters to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
results list will only include information about the DB 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 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 DescribeGlobalClusters 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 DescribeGlobalClusters request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
SdkInternalList<T> globalClusters
The list of global clusters returned by this request.
String engineName
A required parameter. Options available for the given engine name are described.
String majorEngineVersion
If specified, filters the results to include only options for the specified major engine version.
SdkInternalList<T> 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 request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
SdkInternalList<T> optionGroupOptions
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 optionGroupName
The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
SdkInternalList<T> filters
This parameter is not currently supported.
String marker
An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified,
the response includes only records beyond the marker, up to the value specified by MaxRecords.
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 engineName
Filters the list of option groups to only include groups associated with a specific database engine.
String majorEngineVersion
Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
SdkInternalList<T> optionGroupsList
List of option groups.
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 DB instance options for.
String engineVersion
The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
String dBInstanceClass
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
String licenseModel
The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
Boolean vpc
A value that indicates whether to show only VPC or non-VPC offerings.
SdkInternalList<T> 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 DescribeOrderableDBInstanceOptions request. If this parameter
is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords .
SdkInternalList<T> orderableDBInstanceOptions
An OrderableDBInstanceOption structure containing information about orderable options for the DB
instance.
String marker
An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is
specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords .
String resourceIdentifier
The ARN of a resource to return pending maintenance actions for.
SdkInternalList<T> filters
A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
results list will only include pending maintenance actions for the DB clusters identified by these ARNs.
db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only
include pending maintenance actions for the DB instances identified by these ARNs.
String marker
An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If
this parameter is specified, the response includes only records beyond the marker, up to a number of records
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 called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
SdkInternalList<T> pendingMaintenanceActions
A list of the pending maintenance actions for the resource.
String marker
An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If
this parameter is specified, the response includes only records beyond the marker, up to a number of records
specified by MaxRecords.
String reservedDBInstancesOfferingId
The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String dBInstanceClass
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
String duration
Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
String productDescription
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
The results show offerings that partially match the filter value.
String offeringType
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
Boolean multiAZ
A value that indicates whether to show only those reservations that support Multi-AZ.
SdkInternalList<T> filters
This parameter is not currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more than the MaxRecords value is
available, a pagination token called a marker is included in the response so that the following results can be
retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
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.
SdkInternalList<T> reservedDBInstancesOfferings
A list of reserved DB instance offerings.
String reservedDBInstanceId
The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
String reservedDBInstancesOfferingId
The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
String dBInstanceClass
The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
String duration
The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
String productDescription
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
String offeringType
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
Boolean multiAZ
A value that indicates whether to show only those reservations that support Multi-AZ.
SdkInternalList<T> filters
This parameter is not currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more than the MaxRecords value is
available, a pagination token called a marker is included in the response so that the following results can be
retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
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.
SdkInternalList<T> reservedDBInstances
A list of reserved DB instances.
String regionName
The source AWS Region name. For example, us-east-1.
Constraints:
Must specify a valid AWS Region name.
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 DescribeSourceRegions request. If this parameter
is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
SdkInternalList<T> filters
This parameter is not currently supported.
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.
SdkInternalList<T> sourceRegions
A list of SourceRegion instances that contains each source AWS Region that the current AWS Region can get a Read Replica or a DB snapshot from.
String dBInstanceIdentifier
The customer identifier or the ARN of your DB instance.
String domain
The identifier of the Active Directory Domain.
String status
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
String fQDN
The fully qualified domain name of the Active Directory Domain.
String iAMRoleName
The name of the IAM role to be used when making API calls to the Directory Service.
String dBInstanceIdentifier
The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
Must match the identifier of an existing DBInstance.
String logFileName
The name of the log file to be downloaded.
String marker
The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
Integer numberOfLines
The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.
If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
String logFileData
Entries from the specified log file.
String marker
A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.
Boolean additionalDataPending
Boolean value that if true, indicates there is more data to be downloaded.
String status
Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
String eC2SecurityGroupName
Specifies the name of the EC2 security group.
String eC2SecurityGroupId
Specifies the id of the EC2 security group.
String eC2SecurityGroupOwnerId
Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName
field.
String dBParameterGroupFamily
Specifies the name of the DB parameter group family that the engine default parameters apply to.
String marker
An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the
response includes only records beyond the marker, up to the value specified by MaxRecords .
SdkInternalList<T> parameters
Contains a list of engine default parameters.
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.
SdkInternalList<T> 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 sourceType
The source type that the returned categories belong to
SdkInternalList<T> eventCategories
The event categories for the specified source type
String customerAwsId
The AWS customer account associated with the RDS event notification subscription.
String custSubscriptionId
The RDS event notification subscription Id.
String snsTopicArn
The topic ARN of the RDS event notification subscription.
String status
The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
String subscriptionCreationTime
The time the RDS event notification subscription was created.
String sourceType
The source type for the RDS event notification subscription.
SdkInternalList<T> sourceIdsList
A list of source IDs for the RDS event notification subscription.
SdkInternalList<T> eventCategoriesList
A list of event categories for the RDS event notification subscription.
Boolean enabled
A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
String eventSubscriptionArn
The Amazon Resource Name (ARN) for the event subscription.
String dBClusterIdentifier
A DB 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 Aurora Replica in the DB cluster. For example,
mydbcluster-replica1.
String name
The name of the filter. Filter names are case-sensitive.
SdkInternalList<T> values
One or more filter values. Filter values are case-sensitive.
String globalClusterIdentifier
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
String globalClusterResourceId
The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
String globalClusterArn
The Amazon Resource Name (ARN) for the global database cluster.
String status
Specifies the current state of this global database cluster.
String engine
The Aurora database engine used by the global database cluster.
String engineVersion
Indicates the database engine version.
String databaseName
The default database name within the new global database cluster.
Boolean storageEncrypted
The storage encryption setting for the global database cluster.
Boolean deletionProtection
The deletion protection setting for the new global database cluster.
SdkInternalList<T> globalClusterMembers
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
String dBClusterArn
The Amazon Resource Name (ARN) for each Aurora cluster.
SdkInternalList<T> readers
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
Boolean isWriter
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
String resourceName
The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
SdkInternalList<T> filters
This parameter is not currently supported.
SdkInternalList<T> tagList
List of tags returned by the ListTagsForResource operation.
String dBClusterIdentifier
The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster.
Integer capacity
The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes.
Constraints:
Value must be 1, 2, 4, 8, 16, 32,
64, 128, or 256.
Integer secondsBeforeTimeout
The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Value must be from 10 through 600.
String timeoutAction
The action to take when the timeout is reached, either ForceApplyCapacityChange or
RollbackCapacityChange.
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange ignores the capacity change if a scaling point is not found in the timeout
period.
String dBClusterIdentifier
A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
Integer pendingCapacity
A value that specifies the capacity that the DB cluster scales to next.
Integer currentCapacity
The current capacity of the DB cluster.
Integer secondsBeforeTimeout
The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.
String timeoutAction
The timeout action of a call to ModifyCurrentDBClusterCapacity, either
ForceApplyCapacityChange or RollbackCapacityChange.
String dBClusterEndpointIdentifier
The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
String endpointType
The type of the endpoint. One of: READER, ANY.
SdkInternalList<T> staticMembers
List of DB instance identifiers that are part of the custom endpoint group.
SdkInternalList<T> excludedMembers
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
String dBClusterEndpointIdentifier
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterIdentifier
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointResourceIdentifier
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
String endpoint
The DNS address of the endpoint.
String status
The current status of the endpoint. One of: creating, available, deleting,
modifying.
String endpointType
The type of the endpoint. One of: READER, WRITER, CUSTOM.
String customEndpointType
The type associated with a custom endpoint. One of: READER, ANY.
SdkInternalList<T> staticMembers
List of DB instance identifiers that are part of the custom endpoint group.
SdkInternalList<T> excludedMembers
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
String dBClusterEndpointArn
The Amazon Resource Name (ARN) for the endpoint.
String dBClusterParameterGroupName
The name of the DB cluster parameter group to modify.
SdkInternalList<T> parameters
A list of parameters in the DB cluster parameter group to modify.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
String dBClusterIdentifier
The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
String newDBClusterIdentifier
The new DB cluster identifier for the DB cluster when renaming a DB 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
Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
Boolean applyImmediately
A value that indicates whether the modifications in this request and any pending modifications are asynchronously
applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB
cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication,
MasterUserPassword, and NewDBClusterIdentifier values. If the
ApplyImmediately parameter is disabled, then changes to the
EnableIAMDatabaseAuthentication, MasterUserPassword, and
NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are
applied immediately, regardless of the value of the ApplyImmediately parameter.
By default, this parameter is disabled.
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 DB cluster parameter group to use for the DB cluster.
SdkInternalList<T> vpcSecurityGroupIds
A list of VPC security groups that the DB cluster will belong to.
Integer port
The port number on which the DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String masterUserPassword
The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
String optionGroupName
A value that indicates that the DB cluster should be associated with the specified option group. Changing this
parameter doesn't result in an outage except in the following case, and the change is applied during the next
maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change
results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new
connections are rejected but existing connections are not interrupted.
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
Long backtrackWindow
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
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 ApplyImmediately is enabled.
For a list of valid engine versions, use DescribeDBEngineVersions.
ScalingConfiguration scalingConfiguration
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in
serverless DB engine mode.
Boolean deletionProtection
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
Boolean enableHttpEndpoint
HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
Boolean copyTagsToSnapshot
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
String dBClusterSnapshotIdentifier
The identifier for the DB cluster snapshot to modify the attributes for.
String attributeName
The name of the DB cluster snapshot attribute to modify.
To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to
restore.
SdkInternalList<T> valuesToAdd
A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or
more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account.
Do not add the all value for any manual DB cluster snapshots that contain private information that
you don't want available to all AWS accounts.
SdkInternalList<T> valuesToRemove
A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to
include one or more AWS account identifiers, or all to remove authorization for any AWS account to
copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is
explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.
String dBInstanceIdentifier
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
Integer allocatedStorage
The new amount of storage (in gibibytes) to allocate for the DB instance.
For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
For the valid values for allocated storage for each engine, see CreateDBInstance.
String dBInstanceClass
The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB
instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance
classes, and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
maintenance window, unless ApplyImmediately is enabled for this request.
Default: Uses existing setting
String dBSubnetGroupName
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance in the Amazon RDS User Guide.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
window, unless you enable ApplyImmediately.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
SdkInternalList<T> dBSecurityGroups
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
If supplied, must match existing DBSecurityGroups.
SdkInternalList<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more
information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
Boolean applyImmediately
A value that indicates whether the modifications in this request and any pending modifications are asynchronously
applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB
instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some
parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next
failure reboot. Review the table of parameters in Modifying a DB
Instance in the Amazon RDS User Guide. to see the impact of enabling or disabling
ApplyImmediately for each modified parameter and to determine when the changes are applied.
String masterUserPassword
The new password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Between the time of the request and the completion of the request, the MasterUserPassword element
exists in the PendingModifiedValues element of the operation response.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see
ModifyDBCluster.
Default: Uses existing setting
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
String dBParameterGroupName
The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The DB instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
Integer backupRetentionPeriod
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value
to 0. These changes are applied during the next maintenance window unless the ApplyImmediately
parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero
value, the change is asynchronously applied as soon as possible.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information,
see ModifyDBCluster.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35
Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6 or later
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Can't be set to 0 if the DB instance is a source to Read Replicas
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the
change is asynchronously applied as soon as possible.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more
information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Must be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
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, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
Boolean multiAZ
A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result
in an outage and the change is applied during the next maintenance window unless the
ApplyImmediately parameter is enabled for this request.
String engineVersion
The version number of the database engine to upgrade to. Changing this parameter results in an outage and the
change is applied during the next maintenance window unless the ApplyImmediately parameter is
eanbled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
For information about valid engine versions, see CreateDBInstance, or call
DescribeDBEngineVersions.
Boolean allowMajorVersionUpgrade
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
Boolean autoMinorVersionUpgrade
A value that indicates whether minor version upgrades are applied automatically to the DB 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 enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
String licenseModel
The license model for the DB instance.
Valid values: license-included | bring-your-own-license |
general-public-license
Integer iops
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window
unless the ApplyImmediately parameter is enabled for this request. If you are migrating from
Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change
in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Default: Uses existing setting
String optionGroupName
Indicates that the DB instance should be associated with the specified option group. Changing this parameter
doesn't result in an outage except in the following case and the change is applied during the next maintenance
window unless the ApplyImmediately parameter is enabled for this request. If the parameter change
results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new
connections are rejected but existing connections are not interrupted.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
String newDBInstanceIdentifier
The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance
identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur
during the next maintenance window if you disable Apply Immediately. 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.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
String storageType
Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (io1), you must also include a value for the Iops
parameter.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
Valid values: standard | gp2 | io1
Default: io1 if the Iops parameter is specified, otherwise gp2
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
String tdeCredentialPassword
The password for the given ARN from the key store in order to access the device.
String cACertificateIdentifier
Indicates the certificate that needs to be associated with the instance.
String domain
The Active Directory Domain to move the instance to. Specify none to remove the instance from its
current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server
instance can be created in a Active Directory Domain.
Boolean 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.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB
instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster.
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Integer dBPortNumber
The port number on which the database accepts connections.
The value of the DBPortNumber parameter must not match any of the port values specified for options
in the option group for the DB instance.
Your database will restart when you change the DBPortNumber value regardless of the value of the
ApplyImmediately parameter.
MySQL
Default: 3306
Valid Values: 1150-65535
MariaDB
Default: 3306
Valid Values: 1150-65535
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535 except for 1434, 3389, 47001,
49152, and 49152 through 49156.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Boolean publiclyAccessible
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.
PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public
subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the
ApplyImmediately parameter.
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go
to To
create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a
MonitoringRoleArn value.
String domainIAMRoleName
The name of the IAM role to use when making API calls to the Directory Service.
Integer promotionTier
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
Default: 1
Valid Values: 0 - 15
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
You can enable IAM database authentication for the following database engines
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information,
see ModifyDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Boolean enablePerformanceInsights
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
String performanceInsightsKMSKeyId
The AWS KMS key identifier for encryption of Performance Insights data. 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 do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS 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.
Integer performanceInsightsRetentionPeriod
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance
immediately. Therefore, the ApplyImmediately parameter has no effect.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Boolean useDefaultProcessorFeatures
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
Boolean deletionProtection
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
SdkInternalList<T> parameters
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
String dBParameterGroupName
Provides the name of the DB parameter group.
String dBSnapshotIdentifier
The identifier for the DB snapshot to modify the attributes for.
String attributeName
The name of the DB snapshot attribute to modify.
To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to
restore.
SdkInternalList<T> valuesToAdd
A list of DB snapshot attributes to add to the attribute specified by AttributeName.
To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS
account IDs, or all to make the manual DB snapshot restorable by any AWS account. Do not add the
all value for any manual DB snapshots that contain private information that you don't want available
to all AWS accounts.
SdkInternalList<T> valuesToRemove
A list of DB snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one
or more AWS account identifiers, or all to remove authorization for any AWS account to copy or
restore the DB snapshot. If you specify all, an AWS account whose account ID is explicitly added to
the restore attribute can still copy or restore the manual DB snapshot.
String dBSnapshotIdentifier
The identifier of the DB snapshot to modify.
String engineVersion
The engine version to upgrade the DB snapshot to.
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.
MySQL
5.5.46 (supported for 5.1 DB snapshots)
Oracle
12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
String optionGroupName
The option group to identify with the upgraded DB snapshot.
You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option Group Considerations in the Amazon RDS User Guide.
String dBSubnetGroupName
The name for the DB 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 DB subnet group.
SdkInternalList<T> subnetIds
The EC2 subnet IDs for the DB subnet group.
String subscriptionName
The name of the RDS event notification subscription.
String 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.
String sourceType
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
SdkInternalList<T> eventCategories
A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
Boolean enabled
A value that indicates whether to activate the subscription.
String globalClusterIdentifier
The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing global database cluster.
String newGlobalClusterIdentifier
The new cluster identifier for the global database cluster when modifying a global database 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
Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
Boolean deletionProtection
Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.
String optionGroupName
The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
SdkInternalList<T> optionsToInclude
Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
SdkInternalList<T> optionsToRemove
Options in this list are removed from the option group.
Boolean applyImmediately
A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
String optionName
The name of the option.
String optionDescription
The description of the option.
Boolean persistent
Indicate if this option is persistent.
Boolean permanent
Indicate if this option is permanent.
Integer port
If required, the port configured for this option to use.
String optionVersion
The version of the option.
SdkInternalList<T> optionSettings
The option settings for this option.
SdkInternalList<T> dBSecurityGroupMemberships
If the option requires access to a port, then this DB security group allows access to the port.
SdkInternalList<T> vpcSecurityGroupMemberships
If the option requires access to a port, then this VPC security group allows access to the port.
String optionName
The configuration of options to include in a group.
Integer port
The optional port for the option.
String optionVersion
The version for the option.
SdkInternalList<T> dBSecurityGroupMemberships
A list of DBSecurityGroupMembership name strings used for this option.
SdkInternalList<T> vpcSecurityGroupMemberships
A list of VpcSecurityGroupMembership name strings used for this option.
SdkInternalList<T> optionSettings
The option settings to include in an option group.
String optionGroupName
Specifies the name of the option group.
String optionGroupDescription
Provides a description of the option group.
String engineName
Indicates the name of the engine that this option group can be applied to.
String majorEngineVersion
Indicates the major engine version associated with this option group.
SdkInternalList<T> options
Indicates what options are available in the option group.
Boolean allowsVpcAndNonVpcInstanceMemberships
Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true
indicates the option group can be applied to both VPC and non-VPC instances.
String vpcId
If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If
AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group
can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only
be applied to instances that are in the VPC indicated by this field.
String optionGroupArn
The Amazon Resource Name (ARN) for the option group.
String optionGroupName
The name of the option group that the instance belongs to.
String status
The status of the DB instance's option group membership. Valid values are: in-sync,
pending-apply, pending-removal, pending-maintenance-apply,
pending-maintenance-removal, applying, removing, and failed.
String name
The name of the option.
String description
The description of the option.
String engineName
The name of the engine that this option can be applied to.
String majorEngineVersion
Indicates the major engine version that the option is available for.
String minimumRequiredMinorEngineVersion
The minimum required engine version for the option to be applied.
Boolean portRequired
Specifies whether the option requires a port.
Integer defaultPort
If the option requires a port, specifies the default port for the option.
SdkInternalList<T> optionsDependedOn
The options that are prerequisites for this option.
SdkInternalList<T> optionsConflictsWith
The options that conflict with this option.
Boolean persistent
Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
Boolean permanent
Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.
Boolean requiresAutoMinorEngineVersionUpgrade
If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
Boolean vpcOnly
If true, you can only use this option with a DB instance that is in a VPC.
Boolean supportsOptionVersionDowngrade
If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
SdkInternalList<T> optionGroupOptionSettings
The option settings that are available (and the default value) for each option in an option group.
SdkInternalList<T> optionGroupOptionVersions
The versions that are available for the option.
String settingName
The name of the option group option.
String settingDescription
The description of the option group option.
String defaultValue
The default value for the option group option.
String applyType
The DB engine specific parameter type for the option group option.
String allowedValues
Indicates the acceptable values for the option group option.
Boolean isModifiable
Boolean value where true indicates that this option group option can be changed from the default value.
Boolean isRequired
Boolean value where true indicates that a value must be specified for this option setting of the option group option.
SdkInternalList<T> minimumEngineVersionPerAllowedValue
The minimum DB engine version required for the corresponding allowed value for this option setting.
String name
The name of the option that has settings that you can set.
String value
The current value of the option setting.
String defaultValue
The default value of the option setting.
String description
The description of the option setting.
String applyType
The DB engine specific parameter type.
String dataType
The data type of the option setting.
String allowedValues
The allowed values of the option setting.
Boolean isModifiable
A Boolean value that, when true, indicates the option setting can be modified from the default.
Boolean isCollection
Indicates if the option setting is part of a collection.
String engine
The engine type of a DB instance.
String engineVersion
The engine version of a DB instance.
String dBInstanceClass
The DB instance class for a DB instance.
String licenseModel
The license model for a DB instance.
SdkInternalList<T> availabilityZones
A list of Availability Zones for a DB instance.
Boolean multiAZCapable
Indicates whether a DB instance is Multi-AZ capable.
Boolean readReplicaCapable
Indicates whether a DB instance can have a Read Replica.
Boolean vpc
Indicates whether a DB instance is in a VPC.
Boolean supportsStorageEncryption
Indicates whether a DB instance supports encrypted storage.
String storageType
Indicates the storage type for a DB instance.
Boolean supportsIops
Indicates whether a DB instance supports provisioned IOPS.
Boolean supportsEnhancedMonitoring
Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
Boolean supportsIAMDatabaseAuthentication
Indicates whether a DB instance supports IAM database authentication.
Boolean supportsPerformanceInsights
True if a DB instance supports Performance Insights, otherwise false.
Integer minStorageSize
Minimum storage size for a DB instance.
Integer maxStorageSize
Maximum storage size for a DB instance.
Integer minIopsPerDbInstance
Minimum total provisioned IOPS for a DB instance.
Integer maxIopsPerDbInstance
Maximum total provisioned IOPS for a DB instance.
Double minIopsPerGib
Minimum provisioned IOPS per GiB for a DB instance.
Double maxIopsPerGib
Maximum provisioned IOPS per GiB for a DB instance.
SdkInternalList<T> availableProcessorFeatures
A list of the available processor features for the DB instance class of a DB instance.
SdkInternalList<T> supportedEngineModes
A list of the supported DB engine modes.
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.
SdkInternalList<T> supportedEngineModes
The valid DB engine modes.
SdkInternalList<T> logTypesToEnable
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
SdkInternalList<T> logTypesToDisable
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
String action
The type of pending maintenance action that is available for the resource. Valid actions are
system-update, db-upgrade, and hardware-maintenance.
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. This date takes into account
opt-in requests received from the ApplyPendingMaintenanceAction API, the
AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request
has not been received and nothing has been specified as AutoAppliedAfterDate or
ForcedApplyDate.
String description
A description providing more detail about the maintenance action.
String dBInstanceClass
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being
applied.
Integer allocatedStorage
Contains the new AllocatedStorage size for the DB 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 DB instance.
Integer port
Specifies the pending port for the DB instance.
Integer backupRetentionPeriod
Specifies the pending number of days for which automated backups are retained.
Boolean multiAZ
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
String engineVersion
Indicates the database engine version.
String licenseModel
The license model for the DB instance.
Valid values: license-included | bring-your-own-license |
general-public-license
Integer iops
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
String dBInstanceIdentifier
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being
applied.
String storageType
Specifies the storage type to be associated with the DB instance.
String cACertificateIdentifier
Specifies the identifier of the CA certificate for the DB instance.
String dBSubnetGroupName
The new DB subnet group for the DB instance.
PendingCloudwatchLogsExports pendingCloudwatchLogsExports
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
String dBClusterIdentifier
The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster Read Replica.
Example: my-cluster-replica1
String dBInstanceIdentifier
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing Read Replica DB instance.
Example: mydbinstance
Integer backupRetentionPeriod
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
Must be a value from 0 to 8
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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
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 reservedDBInstancesOfferingId
The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String reservedDBInstanceId
Customer-specified identifier to track this reservation.
Example: myreservationID
Integer dBInstanceCount
The number of instances to reserve.
Default: 1
SdkInternalList<T> tags
Integer from
The minimum value in the range.
Integer to
The maximum value in the range.
Integer step
The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...
String dBInstanceIdentifier
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
Boolean forceFailover
A value that indicates whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can't enable force failover if the instance is not configured for Multi-AZ.
String dBClusterIdentifier
The name of the DB cluster to disassociate the IAM role from.
String roleArn
The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example
arn:aws:iam::123456789012:role/AuroraAccessRole.
String featureName
The name of the feature for the DB cluster that the IAM role is to be disassociated from. For the list of supported feature names, see DBEngineVersion.
String dBInstanceIdentifier
The name of the DB instance to disassociate the IAM role from.
String roleArn
The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example
arn:aws:iam::123456789012:role/AccessRole.
String featureName
The name of the feature for the DB instance that the IAM role is to be disassociated from. For the list of
supported feature names, see DBEngineVersion.
String subscriptionName
The name of the RDS event notification subscription you want to remove a source identifier from.
String sourceIdentifier
The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
String resourceName
The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
SdkInternalList<T> tagKeys
The tag key (name) of the tag to be removed.
String reservedDBInstanceId
The unique identifier for the reservation.
String reservedDBInstancesOfferingId
The offering identifier.
String dBInstanceClass
The DB instance class for the reserved DB instance.
Date startTime
The time the reservation started.
Integer duration
The duration of the reservation in seconds.
Double fixedPrice
The fixed price charged for this reserved DB instance.
Double usagePrice
The hourly price charged for this reserved DB instance.
String currencyCode
The currency code for the reserved DB instance.
Integer dBInstanceCount
The number of reserved DB instances.
String productDescription
The description of the reserved DB instance.
String offeringType
The offering type of this reserved DB instance.
Boolean multiAZ
Indicates if the reservation applies to Multi-AZ deployments.
String state
The state of the reserved DB instance.
SdkInternalList<T> recurringCharges
The recurring price charged to run this reserved DB instance.
String reservedDBInstanceArn
The Amazon Resource Name (ARN) for the reserved DB instance.
String reservedDBInstancesOfferingId
The offering identifier.
String dBInstanceClass
The DB instance class for the reserved DB instance.
Integer duration
The duration of the offering in seconds.
Double fixedPrice
The fixed price charged for this offering.
Double usagePrice
The hourly price charged for this offering.
String currencyCode
The currency code for the reserved DB instance offering.
String productDescription
The database engine used by the offering.
String offeringType
The offering type.
Boolean multiAZ
Indicates if the offering applies to Multi-AZ deployments.
SdkInternalList<T> recurringCharges
The recurring price charged to run this reserved DB instance.
String dBClusterParameterGroupName
The name of the DB cluster parameter group to reset.
Boolean resetAllParameters
A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values.
You can't use this parameter if there is a list of parameter names specified for the Parameters
parameter.
SdkInternalList<T> parameters
A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this
parameter if the ResetAllParameters parameter is enabled.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
Must match the name of an existing DBParameterGroup.
Boolean resetAllParameters
A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.
SdkInternalList<T> parameters
To reset the entire DB parameter group, specify the DBParameterGroup name and
ResetAllParameters parameters. To reset specific parameters, provide a list of the following:
ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single
request.
MySQL
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value
for both dynamic and static parameters, and changes are applied when DB instance reboots.
MariaDB
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value
for both dynamic and static parameters, and changes are applied when DB instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
String dBParameterGroupName
Provides the name of the DB parameter group.
String resourceIdentifier
The ARN of the resource that has pending maintenance actions.
SdkInternalList<T> pendingMaintenanceActionDetails
A list that provides details about the pending maintenance actions for the resource.
SdkInternalList<T> availabilityZones
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Integer backupRetentionPeriod
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
String characterSetName
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
String databaseName
The database name for the restored DB cluster.
String dBClusterIdentifier
The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter is isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
String dBClusterParameterGroupName
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is
omitted, default.aurora5.6 is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
SdkInternalList<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with the restored DB cluster.
String dBSubnetGroupName
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
String engine
The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora, aurora-postgresql
String engineVersion
The version number of the database engine to use.
Aurora MySQL
Example: 5.6.10a
Aurora PostgreSQL
Example: 9.6.3
Integer port
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
String masterUsername
The name of the master user for the restored DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't 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 "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
String optionGroupName
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
SdkInternalList<T> tags
Boolean storageEncrypted
A value that indicates whether the restored DB cluster is encrypted.
String kmsKeyId
The AWS KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS will use 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.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
String sourceEngine
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
String sourceEngineVersion
The version of the database that the backup files were created from.
MySQL version 5.5 and 5.6 are supported.
Example: 5.6.22
String s3BucketName
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
String s3Prefix
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
String s3IngestionRoleArn
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
Long backtrackWindow
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Boolean deletionProtection
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
Boolean copyTagsToSnapshot
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
SdkInternalList<T> availabilityZones
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
String dBClusterIdentifier
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
String snapshotIdentifier
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
String engine
The database engine to use for the new DB 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 DB cluster.
Integer port
The port number on which the new DB cluster accepts connections.
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
String dBSubnetGroupName
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mySubnetgroup
String databaseName
The database name for the restored DB cluster.
String optionGroupName
The name of the option group to use for the restored DB cluster.
SdkInternalList<T> vpcSecurityGroupIds
A list of VPC security groups that the new DB cluster will belong to.
SdkInternalList<T> tags
The tags to be assigned to the restored DB cluster.
String kmsKeyId
The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB
cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored
DB cluster is not encrypted.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
Long backtrackWindow
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
String engineMode
The DB engine mode of the DB cluster, either provisioned, serverless, or
parallelquery.
ScalingConfiguration scalingConfiguration
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
String dBClusterParameterGroupName
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Boolean deletionProtection
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
Boolean copyTagsToSnapshot
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
String dBClusterIdentifier
The name of the new DB cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
String 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.
Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is
earlier than 1.11.
If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the
source DB cluster.
String sourceDBClusterIdentifier
The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Date restoreToTime
The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Must be specified if UseLatestRestorableTime parameter is not provided
Can't be specified if the UseLatestRestorableTime parameter is enabled
Can't be specified if the RestoreType parameter is copy-on-write
Example: 2015-03-07T23:45:00Z
Boolean useLatestRestorableTime
A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
Constraints: Can't be specified if RestoreToTime parameter is provided.
Integer port
The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535.
Default: The default port for the engine.
String dBSubnetGroupName
The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
String optionGroupName
The name of the option group for the new DB cluster.
SdkInternalList<T> vpcSecurityGroupIds
A list of VPC security groups that the new DB cluster belongs to.
SdkInternalList<T> tags
String kmsKeyId
The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS
key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the
KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is
rejected.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
Long backtrackWindow
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
String dBClusterParameterGroupName
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Boolean deletionProtection
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
Boolean copyTagsToSnapshot
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
String dBInstanceIdentifier
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 numbers, letters, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
String dBSnapshotIdentifier
The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DBSnapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of
the shared DB snapshot.
String dBInstanceClass
The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB
instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance
classes, and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
Integer port
The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
String availabilityZone
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ
deployment.
Example: us-east-1a
String dBSubnetGroupName
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
Boolean multiAZ
A value that indicates whether the DB instance is a Multi-AZ deployment.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ
deployment.
Boolean publiclyAccessible
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
Boolean autoMinorVersionUpgrade
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
String licenseModel
License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license |
general-public-license
String dBName
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
String engine
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Integer iops
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
Constraints: Must be an integer greater than 1000.
String optionGroupName
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
SdkInternalList<T> tags
String storageType
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
String tdeCredentialPassword
The password for the given ARN from the key store in order to access the device.
SdkInternalList<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
String domain
Specify the Active Directory Domain to restore the instance in.
Boolean copyTagsToSnapshot
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
String domainIAMRoleName
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Boolean useDefaultProcessorFeatures
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
String dBParameterGroupName
The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Boolean deletionProtection
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
String dBName
The name of the database to create when the DB instance is created. Follow the naming rules specified in
CreateDBInstance.
String dBInstanceIdentifier
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
Integer allocatedStorage
The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules
specified in CreateDBInstance.
Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
String dBInstanceClass
The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance
classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes,
and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
Importing from Amazon S3 is not supported on the db.t2.micro DB instance class.
String engine
The name of the database engine to be used for this instance.
Valid Values: mysql
String masterUsername
The name for the master user.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
String masterUserPassword
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
SdkInternalList<T> dBSecurityGroups
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
SdkInternalList<T> vpcSecurityGroupIds
A list of VPC security groups to associate with this DB instance.
String availabilityZone
The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
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 DB instance is a Multi-AZ
deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.
String dBSubnetGroupName
A DB subnet group to associate with this DB instance.
String preferredMaintenanceWindow
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
String dBParameterGroupName
The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used.
Integer backupRetentionPeriod
The number of days for which automated backups are retained. Setting this parameter to a positive number enables
backups. For more information, see CreateDBInstance.
String preferredBackupWindow
The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window in the Amazon RDS User Guide.
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.
Integer port
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150-65535
Default: 3306
Boolean multiAZ
A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ
deployment, you can't set the AvailabilityZone parameter.
String engineVersion
The version number of the database engine to use. Choose the latest minor version of your database engine. For
information about engine versions, see CreateDBInstance, or call
DescribeDBEngineVersions.
Boolean autoMinorVersionUpgrade
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
String licenseModel
The license model for this DB instance. Use general-public-license.
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
String optionGroupName
The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
Boolean publiclyAccessible
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
SdkInternalList<T> tags
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
String storageType
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise gp2
Boolean storageEncrypted
A value that indicates whether the new DB instance is encrypted or not.
String kmsKeyId
The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the
KmsKeyId parameter, then Amazon RDS will use 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.
Boolean 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.
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see
Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a
MonitoringRoleArn value.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
String sourceEngine
The name of the engine of your source database.
Valid Values: mysql
String sourceEngineVersion
The engine version of your source database.
Valid Values: 5.6
String s3BucketName
The name of your Amazon S3 bucket that contains your database backup file.
String s3Prefix
The prefix of your Amazon S3 bucket.
String s3IngestionRoleArn
An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
Boolean enablePerformanceInsights
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
String performanceInsightsKMSKeyId
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS 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.
Integer performanceInsightsRetentionPeriod
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Boolean useDefaultProcessorFeatures
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
Boolean deletionProtection
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
String sourceDBInstanceIdentifier
The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
String targetDBInstanceIdentifier
The name of the new DB instance to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Date restoreTime
The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Can't be specified if the UseLatestRestorableTime parameter is enabled
Example: 2009-09-07T23:45:00Z
Boolean useLatestRestorableTime
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance is not restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime parameter is provided.
String dBInstanceClass
The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB
instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance
classes, and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
Integer port
The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
String availabilityZone
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ
deployment.
Example: us-east-1a
String dBSubnetGroupName
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
Boolean multiAZ
A value that indicates whether the DB instance is a Multi-AZ deployment.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ
deployment.
Boolean publiclyAccessible
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
Boolean autoMinorVersionUpgrade
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
String licenseModel
License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license |
general-public-license
String dBName
The database name for the restored DB instance.
This parameter is not used for the MySQL or MariaDB engines.
String engine
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
String optionGroupName
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
Boolean copyTagsToSnapshot
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
SdkInternalList<T> tags
String storageType
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
String tdeCredentialPassword
The password for the given ARN from the key store in order to access the device.
SdkInternalList<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
String domain
Specify the Active Directory Domain to restore the instance in.
String domainIAMRoleName
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Boolean useDefaultProcessorFeatures
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
String dBParameterGroupName
The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Boolean deletionProtection
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
String sourceDbiResourceId
The resource ID of the source DB instance from which to restore.
String dBSecurityGroupName
The name of the DB security group to revoke ingress from.
String cIDRIP
The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified,
EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't
be provided.
String eC2SecurityGroupName
The name of the EC2 security group to revoke access from. For VPC DB security groups,
EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId must be provided.
String eC2SecurityGroupId
The id of the EC2 security group to revoke access from. For VPC DB security groups,
EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId must be provided.
String eC2SecurityGroupOwnerId
The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName
parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups,
EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Integer minCapacity
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
Valid capacity values are 1, 2, 4, 8, 16,
32, 64, 128, and 256.
The minimum capacity must be less than or equal to the maximum capacity.
Integer maxCapacity
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
Valid capacity values are 1, 2, 4, 8, 16,
32, 64, 128, and 256.
The maximum capacity must be greater than or equal to the minimum capacity.
Boolean autoPause
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in
serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
Integer secondsUntilAutoPause
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
String timeoutAction
The action to take when the timeout is reached, either ForceApplyCapacityChange or
RollbackCapacityChange.
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point is not found in
the timeout period.
If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a
scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.
Integer minCapacity
The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
Integer maxCapacity
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
Boolean autoPause
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB
engine mode.
When the value is set to false for an Aurora Serverless DB cluster, the DB cluster automatically resumes.
Integer secondsUntilAutoPause
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused.
A DB cluster can be paused only when it's idle (it has no connections).
String timeoutAction
The timeout action of a call to ModifyCurrentDBClusterCapacity, either
ForceApplyCapacityChange or RollbackCapacityChange.
String dBClusterIdentifier
The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.
String dBInstanceIdentifier
The user-supplied instance identifier.
String dBClusterIdentifier
The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.
String subnetIdentifier
Specifies the identifier of the subnet.
AvailabilityZone subnetAvailabilityZone
String subnetStatus
Specifies the status of the subnet.
String key
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
String value
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
String timezoneName
The name of the time zone.
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 a DB 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.
SdkInternalList<T> storage
Valid storage options for your DB instance.
SdkInternalList<T> validProcessorFeatures
Valid processor features for your DB instance.
String storageType
The valid storage types for your DB instance. For example, gp2, io1.
SdkInternalList<T> storageSize
The valid range of storage in gibibytes. For example, 100 to 16384.
SdkInternalList<T> provisionedIops
The valid range of provisioned IOPS. For example, 1000-20000.
SdkInternalList<T> iopsToStorageRatio
The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.
Copyright © 2019. All rights reserved.