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. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
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 the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
com.amazonaws.internal.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
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 cannot 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 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.
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 RDS Amazon Resource Name (ARN).
Constraints:
Must specify a valid DB cluster parameter group.
If the source DB cluster parameter group is in the same 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 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:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-cluster-param-group1
String targetDBClusterParameterGroupDescription
A description for the copied DB cluster parameter group.
com.amazonaws.internal.SdkInternalList<T> tags
String sourceDBClusterSnapshotIdentifier
The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
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 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-snapshot2
String kmsKeyId
The AWS KMS key ID for an encrypted 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 unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter,
Amazon RDS encrypts the target DB cluster snapshot using the specified 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 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 region. KMS encryption keys are
specific to the region that they are created in, and you cannot use encryption keys from one region in another
region.
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 region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL
request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot
in the destination region. This is the same identifier for both the CopyDBClusterSnapshot action
that is called in the destination region, and the action contained in the pre-signed URL.
DestinationRegion - The name of the 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 region.
For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 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
com.amazonaws.internal.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 RDS Amazon Resource Name (ARN).
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:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-db-parameter-group
String targetDBParameterGroupDescription
A description for the copied DB parameter group.
com.amazonaws.internal.SdkInternalList<T> tags
String sourceDBSnapshotIdentifier
The identifier for the source DB snapshot.
If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot.
You cannot copy an encrypted, shared DB 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 region as the copy, specify a valid DB snapshot identifier.
If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot.
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 copied snapshot.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot 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 unencrypted DB snapshot and specify a value for the KmsKeyId parameter, Amazon RDS
encrypts the target DB snapshot using the specified KMS encryption key.
If you copy an encrypted DB 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 snapshot is encrypted with the same KMS key as the source DB snapshot.
If you copy an encrypted snapshot to a different AWS region, then you must specify a KMS key for the destination AWS region.
If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for
KmsKeyId.
To copy an encrypted DB snapshot to another region, you must set KmsKeyId to the KMS key ID used to
encrypt the copy of the DB snapshot in the destination region. KMS encryption keys are specific to the region
that they are created in, and you cannot use encryption keys from one region in another region.
com.amazonaws.internal.SdkInternalList<T> tags
Boolean copyTags
True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.
String preSignedUrl
The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the
AWS region that contains the source DB snapshot to copy. The PreSignedUrl parameter must be used
when copying an encrypted DB snapshot from another AWS region.
The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in
the source 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 will be copied to. This 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 region to the us-east-1 region, then you
will call the CopyDBSnapshot action in the us-east-1 region and provide a presigned URL that
contains a call to the CopyDBSnapshot action in the us-west-2 region. For this example, the
DestinationRegion in the presigned URL must be set to the us-east-1 region.
KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the
destination region. This is the same identifier for both the CopyDBSnapshot action that is called in
the destination 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 region. For example, if you are
copying an encrypted DB snapshot from the us-west-2 region, then your SourceDBSnapshotIdentifier
would look like 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 sourceRegion
String sourceOptionGroupIdentifier
The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
Constraints:
Must specify a valid option group.
If the source option group is in the same 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 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:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-option-group
String targetOptionGroupDescription
The description for the copied option group.
com.amazonaws.internal.SdkInternalList<T> tags
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
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.
String description
The description for the DB cluster parameter group.
com.amazonaws.internal.SdkInternalList<T> tags
com.amazonaws.internal.SdkInternalList<T> availabilityZones
A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
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 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 8 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 alphanumeric characters or hyphens.
First character must be a letter.
Cannot 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 will be used.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
com.amazonaws.internal.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 contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
String engine
The name of the database engine to be used for this DB cluster.
Valid Values: aurora
String engineVersion
The version number of the database engine to use.
Aurora
Example: 5.6.10a
Integer port
The port number on which the instances in the DB cluster accept connections.
Default: 3306
String masterUsername
The name of the master user for the DB cluster.
Constraints:
Must be 1 to 16 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
String masterUserPassword
The password for the master database user. This password can contain any printable ASCII character except "/", """, 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 cannot be removed from an option group. The option group cannot 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.
Default: A 30-minute window selected at random from an 8-hour block of time per 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.
Times should 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
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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.
com.amazonaws.internal.SdkInternalList<T> tags
Boolean storageEncrypted
Specifies whether the DB cluster is encrypted.
String kmsKeyId
The 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 the StorageEncrypted parameter is true, 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.
If you create a Read Replica of an encrypted DB cluster in another region, you must set KmsKeyId to
a KMS key ID that is valid in the destination region. This key is used to encrypt the Read Replica in that
region.
String preSignedUrl
A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called
in the source region where the DB cluster will be 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 region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster in the
destination region. This should refer to the same KMS key for both the CreateDBCluster action that
is called in the destination region, and the action contained in the pre-signed URL.
DestinationRegion - The name of the 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 region. For example, if you are
copying an encrypted DB cluster from the us-west-2 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.
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 alphanumeric characters or hyphens.
First character must be a letter.
Cannot 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 contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
com.amazonaws.internal.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, or PostgreSQL DB instance.
Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later.
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 region as the Read Replica, specify a valid DB instance identifier.
If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
String dBInstanceClass
The compute and memory capacity of the Read Replica. Note that not all instance classes are available in all regions for all DB engines.
Valid Values:
db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
Default: Inherits from the source DB instance.
String availabilityZone
The Amazon EC2 Availability Zone that the Read Replica will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's 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 autoMinorVersionUpgrade
Indicates that minor engine upgrades will be 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 will be associated with. If omitted, the default option group for the engine specified will be used.
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.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
com.amazonaws.internal.SdkInternalList<T> tags
String dBSubnetGroupName
Specifies a DB subnet group for the DB instance. The new DB instance will be 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 region.
The specified DB subnet group must be in the same region in which the operation is running.
All Read Replicas in one region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
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 standard
Boolean copyTagsToSnapshot
True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.
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 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.
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 unencrypted Read Replica and specify a value for the KmsKeyId parameter, Amazon RDS
encrypts the target Read Replica using the specified KMS encryption key.
If you create an encrypted Read Replica from your AWS account, you can specify a value for KmsKeyId
to encrypt the Read Replica with a new KMS encryption key. If you don't specify a value for KmsKeyId
, then 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 region that they are created in, and you cannot use encryption keys from one region in another region.
String preSignedUrl
The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API
action in the AWS region that contains the source DB instance. The PreSignedUrl parameter must be
used when encrypting a Read Replica from another AWS region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be
executed in the source region that contains the encrypted DB instance. The presigned URL request must contain the
following parameter values:
DestinationRegion - The AWS Region that the Read Replica is created in. This region is the same one
where the CreateDBInstanceReadReplica action is called that contains this presigned URL.
For example, if you create an encrypted Read Replica in the us-east-1 region, and the source DB instance is in
the west-2 region, then you call the CreateDBInstanceReadReplica action in the us-east-1 region and
provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the
us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the
us-east-1 region.
KmsKeyId - The KMS key identifier for the key to use to encrypt the Read Replica in the destination
region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called
in the destination region, and the action contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the encrypted Read Replica to be
created. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if
you create an encrypted Read Replica from a DB instance in the us-west-2 region, then your
SourceDBInstanceIdentifier would look like this example:
arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-instance-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 sourceRegion
String dBName
The meaning of this parameter differs according to the database engine you use.
Type: String
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 alphanumeric characters
Cannot 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 alphanumeric characters
Cannot 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 alphanumeric characters
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Cannot be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
Cannot 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 alphanumeric characters
Cannot 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 alphanumeric characters or hyphens (1 to 15 for SQL Server).
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
Integer allocatedStorage
The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 6144.
MariaDB
Constraints: Must be an integer from 5 to 6144.
PostgreSQL
Constraints: Must be an integer from 5 to 6144.
Oracle
Constraints: Must be an integer from 10 to 6144.
SQL Server
Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)
String dBInstanceClass
The compute and memory capacity of the DB instance. Note that not all instance classes are available in all regions for all DB engines.
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
String engine
The name of the database engine to be used for this instance.
Valid Values: mysql | mariadb | oracle-se1 | oracle-se2 |
oracle-se | oracle-ee | sqlserver-ee | sqlserver-se |
sqlserver-ex | sqlserver-web | postgres | aurora
Not every database engine is available for every AWS region.
String masterUsername
The name of master user for the client DB instance.
MySQL
Constraints:
Must be 1 to 16 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
MariaDB
Constraints:
Must be 1 to 16 alphanumeric characters.
Cannot be a reserved word for the chosen database engine.
Type: String
Oracle
Constraints:
Must be 1 to 30 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
SQL Server
Constraints:
Must be 1 to 128 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Must be 1 to 63 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
String masterUserPassword
The password for the master database user. Can be any printable ASCII character except "/", """, or "@".
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon Aurora
Constraints: Must contain from 8 to 41 characters.
com.amazonaws.internal.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.
com.amazonaws.internal.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 availabilityZone
The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to
true. The specified Availability Zone must be in the same 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 weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
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 will be used.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot 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.
Default: 1
Constraints:
Must be a value from 0 to 35
Cannot 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 DB
Instance Backups.
Default: A 30-minute window selected at random from an 8-hour block of time per 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.
Times should 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
Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
String engineVersion
The version number of the database engine to use.
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.
Amazon Aurora
Version 5.6 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-2,
eu-west-1, us-east-1, us-east-2, us-west-2): 5.6.10a
MariaDB
Version 10.1 (available in these AWS regions: us-east-2): 10.1.16
Version 10.1 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1,
ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 10.1.14
Version 10.0 (available in all AWS regions): 10.0.24
Version 10.0 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1,
ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2):
10.0.17
Microsoft SQL Server 2016
13.00.2164.0.v1 (supported for all editions, and all AWS regions except sa-east-1)
Microsoft SQL Server 2014
12.00.5000.0.v1 (supported for all editions, and all AWS regions)
12.00.4422.0.v1 (supported for all editions except Enterprise Edition, and all AWS regions except
us-east-2)
Microsoft SQL Server 2012
11.00.6020.0.v1 (supported for all editions, and all AWS regions)
11.00.5058.0.v1 (supported for all editions, and all AWS regions except us-east-2)
11.00.2100.60.v1 (supported for all editions, and all AWS regions except us-east-2)
Microsoft SQL Server 2008 R2
10.50.6529.0.v1 (supported for all editions, and all AWS regions except us-east-2)
10.50.6000.34.v1 (supported for all editions, and all AWS regions except us-east-2)
10.50.2789.0.v1 (supported for all editions, and all AWS regions except us-east-2)
MySQL
Version 5.7 (available in all AWS regions): 5.7.11
Version 5.7 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1,
ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2):
5.7.10
Version 5.6 (available in all AWS regions): 5.6.29
Version 5.6 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1,
ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2):
5.6.27
Version 5.6 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2,
eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.6.23
Version 5.6 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1,
eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2):
5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22
Version 5.5 (available in all AWS regions): 5.5.46
Version 5.1 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.1.73a | 5.1.73b
Oracle Database Enterprise Edition (oracle-ee)
Version 12.1 (available in all AWS regions except ap-south-1, ap-northeast-2):
12.1.0.1.v1 | 12.1.0.1.v2
Version 12.1 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1,
eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.1.v3 | 12.1.0.1.v4 | 12.1.0.1.v5
Version 12.1 (available in all AWS regions): 12.1.0.2.v1
Version 12.1 (available in all AWS regions except us-gov-west-1):
12.1.0.2.v2 | 12.1.0.2.v3 | 12.1.0.2.v4
Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
Version 11.2 (available in all AWS regions except ap-south-1, ap-northeast-2):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3
Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1,
eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 11.2.0.3.v4
Version 11.2 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
Version 11.2 (available in all AWS regions except us-gov-west-1):
11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7 | 11.2.0.4.v8
Oracle Database Standard Edition (oracle-se)
Version 12.1 (available in all AWS regions except ap-south-1, ap-northeast-2):
12.1.0.1.v1 | 12.1.0.1.v2
Version 12.1 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1,
eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.1.v3 | 12.1.0.1.v4 | 12.1.0.1.v5
Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
Version 11.2 (available in all AWS regions except ap-south-1, ap-northeast-2):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3
Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1,
eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 11.2.0.3.v4
Version 11.2 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
Version 11.2 (available in all AWS regions except us-gov-west-1):
11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7 | 11.2.0.4.v8
Oracle Database Standard Edition One (oracle-se1)
Version 12.1 (available in all AWS regions except ap-south-1, ap-northeast-2):
12.1.0.1.v1 | 12.1.0.1.v2
Version 12.1 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1,
eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.1.v3 | 12.1.0.1.v4 | 12.1.0.1.v5
Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
Version 11.2 (available in all AWS regions except ap-south-1, ap-northeast-2):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3
Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1,
eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 11.2.0.3.v4
Version 11.2 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
Version 11.2 (available in all AWS regions except us-gov-west-1):
11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7 | 11.2.0.4.v8
Oracle Database Standard Edition Two (oracle-se2)
Version 12.1 (available in all AWS regions except us-gov-west-1):
12.1.0.2.v2 | 12.1.0.2.v3 | 12.1.0.2.v4
PostgreSQL
Version 9.6: 9.6.1
Version 9.5: 9.5.4 | 9.5.2
Version 9.4: 9.4.9 | 9.4.7 | 9.4.5 | 9.4.4 | 9.4.1
Version 9.3: 9.3.14 | 9.3.12 | 9.3.10 | 9.3.9 | 9.3.6 | 9.3.5 | 9.3.3 | 9.3.2 | 9.3.1
Oracle 12c
12.1.0.2.v6 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v5 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v4 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v3 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v2 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v1 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.1.v6 (supported for EE, SE1, and SE, in all AWS regions except ap-south-1, ap-northeast-2)
12.1.0.1.v5 (supported for EE, SE1, and SE, in all AWS regions except ap-south-1, ap-northeast-2)
12.1.0.1.v4 (supported for EE, SE1, and SE, in all AWS regions except ap-south-1, ap-northeast-2)
12.1.0.1.v3 (supported for EE, SE1, and SE, in all AWS regions except ap-south-1, ap-northeast-2)
12.1.0.1.v2 (supported for EE, SE1, and SE, in all AWS regions except ap-south-1, ap-northeast-2)
12.1.0.1.v1 (supported for EE, SE1, and SE, in all AWS regions except ap-south-1, ap-northeast-2)
Oracle 11g
11.2.0.4.v10 (supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v9 (supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v8 (supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v7 (supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v6 (supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v5 (supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v4 (supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v3 (supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v1 (supported for EE, SE1, and SE, in all AWS regions)
PostgreSQL
Version 9.5 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1,
ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 9.5.4
Version 9.5 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1,
ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2):
9.5.2
Version 9.4 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1,
ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 9.4.9
Version 9.4 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1,
ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2):
9.4.7
Version 9.4 (available in all AWS regions): 9.4.5
Version 9.4 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2,
eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 9.4.4
Version 9.4 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2,
eu-central-1, eu-west-1, sa-east-1, us-east-1, us-east-2, us-gov-west-1, us-west-1, us-west-2):
9.4.1
Version 9.3 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1,
eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2):
9.3.10 | 9.3.3 | 9.3.5 | 9.3.6 | 9.3.9
Version 9.3 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 9.3.1 | 9.3.2
Version 9.3 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1,
eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 9.3.12 | 9.3.14
Boolean autoMinorVersionUpgrade
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
Default: true
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.
Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be an
integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your Iops
value can be 2000, 3000, 4000, or 5000.
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, cannot be removed from an option group, and that option group cannot 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.
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.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
com.amazonaws.internal.SdkInternalList<T> tags
String dBClusterIdentifier
The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
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 standard
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
Specifies whether the DB instance is encrypted.
Default: false
String kmsKeyId
The 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 true, 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
Specify the Active Directory Domain to create the instance in.
Boolean copyTagsToSnapshot
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
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 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.
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.
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.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
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.
String description
The description for the DB parameter group.
com.amazonaws.internal.SdkInternalList<T> tags
String dBSecurityGroupName
The name for the DB security group. This value is stored as a lowercase string.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Must not be "Default"
Example: mysecuritygroup
String dBSecurityGroupDescription
The description for the DB security group.
com.amazonaws.internal.SdkInternalList<T> tags
String dBSnapshotIdentifier
The identifier for the DB snapshot.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
String dBInstanceIdentifier
The DB instance identifier. This is the unique key that identifies a DB instance.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
com.amazonaws.internal.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 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
String dBSubnetGroupDescription
The description for the DB subnet group.
com.amazonaws.internal.SdkInternalList<T> subnetIds
The EC2 Subnet IDs for the DB subnet group.
com.amazonaws.internal.SdkInternalList<T> tags
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 will be 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
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> sourceIds
The list of identifiers of the event sources for which events will be 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 cannot 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 Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
com.amazonaws.internal.SdkInternalList<T> tags
String optionGroupName
Specifies the name of the option group to be created.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot 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.
com.amazonaws.internal.SdkInternalList<T> tags
Integer allocatedStorage
Specifies the allocated storage size in gigabytes (GB).
com.amazonaws.internal.SdkInternalList<T> availabilityZones
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
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
Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then recoonect to the reader endpoint.
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.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> readReplicaIdentifiers
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
com.amazonaws.internal.SdkInternalList<T> dBClusterMembers
Provides the list of instances that make up the DB cluster.
com.amazonaws.internal.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 true, the KMS key identifier for the encrypted DB cluster.
String dbClusterResourceId
The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
String dBClusterArn
The Amazon Resource Name (ARN) for the DB cluster.
com.amazonaws.internal.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.
Date clusterCreateTime
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
String dBInstanceIdentifier
Specifies the instance identifier for this member of the DB cluster.
Boolean isClusterWriter
Value that is true if the cluster member is the primary instance for the DB cluster and
false otherwise.
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.
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.
com.amazonaws.internal.SdkInternalList<T> availabilityZones
Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
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 gigabytes (GB).
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 KMS key identifier for the encrypted DB cluster snapshot.
String dBClusterSnapshotArn
The Amazon Resource Name (ARN) for the DB cluster snapshot.
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.
com.amazonaws.internal.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.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> supportedCharacterSets
A list of the character sets supported by this engine for the CharacterSetName parameter of the
CreateDBInstance action.
com.amazonaws.internal.SdkInternalList<T> validUpgradeTarget
A list of engine versions that this database engine version can be upgraded to.
com.amazonaws.internal.SdkInternalList<T> supportedTimezones
A list of the time zones supported by this engine for the Timezone parameter of the
CreateDBInstance action.
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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora
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 gigabytes.
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.
com.amazonaws.internal.SdkInternalList<T> dBSecurityGroups
Provides List of DB security group elements containing only DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.
com.amazonaws.internal.SdkInternalList<T> vpcSecurityGroups
Provides a list of VPC security group elements that the DB instance belongs to.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> readReplicaDBInstanceIdentifiers
Contains one or more identifiers of the Read Replicas associated with this DB instance.
com.amazonaws.internal.SdkInternalList<T> readReplicaDBClusterIdentifiers
Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
String licenseModel
License model information for this DB instance.
Integer iops
Specifies the Provisioned IOPS (I/O operations per second) value.
com.amazonaws.internal.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.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
com.amazonaws.internal.SdkInternalList<T> statusInfos
The status of a Read Replica. If the instance is not a Read Replica, this will be 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 KMS key identifier for the encrypted DB instance.
String dbiResourceId
The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
String cACertificateIdentifier
The identifier of the CA certificate for this DB instance.
com.amazonaws.internal.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.
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 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.
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.
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, 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.
com.amazonaws.internal.SdkInternalList<T> eC2SecurityGroups
Contains a list of EC2SecurityGroup elements.
com.amazonaws.internal.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 gigabytes (GB).
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 region that the DB snapshot was created in or copied from.
String sourceDBSnapshotIdentifier
The DB snapshot 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 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.
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.
com.amazonaws.internal.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.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> subnets
Contains a list of Subnet elements.
String dBSubnetGroupArn
The Amazon Resource Name (ARN) for the DB subnet group.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
Constraints:
Must be the name of an existing DB cluster parameter group.
You cannot delete a default DB cluster parameter group.
Cannot 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 contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Boolean skipFinalSnapshot
Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true
is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is
created before the DB cluster is deleted.
You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is
false.
Default: false
String finalDBSnapshotIdentifier
The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is
set to false.
Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an
error.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot 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 dBInstanceIdentifier
The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Boolean skipFinalSnapshot
Determines whether a final DB snapshot is created before the DB instance is deleted. If true is
specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB
instance is deleted.
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 the SkipFinalSnapshot parameter is set to "true".
Specify true when deleting a Read Replica.
The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.
Default: false
String finalDBSnapshotIdentifier
The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.
Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Cannot be specified when deleting a Read Replica.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
Must be the name of an existing DB parameter group
You cannot delete a default DB parameter group
Cannot be associated with any DB instances
String dBSecurityGroupName
The name of the DB security group to delete.
You cannot delete the default DB security group.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Must not be "Default"
String dBSnapshotIdentifier
The DBSnapshot 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 cannot delete the default subnet group.
Constraints:
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
String subscriptionName
The name of the RDS event notification subscription you want to delete.
String optionGroupName
The name of the option group to be deleted.
You cannot delete default option groups.
com.amazonaws.internal.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 contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
com.amazonaws.internal.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.
com.amazonaws.internal.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 dBClusterParameterGroupName
The name of a specific DB cluster parameter group to return details for.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
com.amazonaws.internal.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.
com.amazonaws.internal.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:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
String source
A value that indicates to return only parameters for a specific source. Parameter sources can be
engine, service, or customer.
com.amazonaws.internal.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.
com.amazonaws.internal.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 cannot be used in
conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
String dBClusterSnapshotIdentifier
A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the
DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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 setting the
IncludeShared parameter to true. You can include public DB cluster snapshots with these
results by setting the IncludePublic parameter to true.
The IncludeShared and IncludePublic parameters don't apply for
SnapshotType values of manual or automated. The IncludePublic
parameter doesn't apply when SnapshotType is set to shared. The
IncludeShared parameter doesn't apply when SnapshotType is set to public.
com.amazonaws.internal.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
Set this value to true to include shared manual DB cluster snapshots from other AWS accounts that
this AWS account has been given permission to copy or restore, otherwise set this value to false.
The default is false.
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
Set this value to true to include manual DB cluster snapshots that are public and can be copied or
restored by any AWS account, otherwise set this value to false. The default is false.
The default is false.
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.
com.amazonaws.internal.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:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
com.amazonaws.internal.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.
com.amazonaws.internal.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:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
com.amazonaws.internal.SdkInternalList<T> filters
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
Indicates that only the default version of the specified engine or engine and major version combination is returned.
Boolean listSupportedCharacterSets
If this parameter is specified and the requested engine supports the CharacterSetName parameter for
CreateDBInstance, the response includes a list of supported character sets for each engine version.
Boolean listSupportedTimezones
If this parameter is specified and the requested engine supports the TimeZone parameter for
CreateDBInstance, the response includes a list of supported time zones for each engine version.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
com.amazonaws.internal.SdkInternalList<T> dBEngineVersions
A list of DBEngineVersion elements.
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:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
com.amazonaws.internal.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 .
com.amazonaws.internal.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 contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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.
com.amazonaws.internal.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.
com.amazonaws.internal.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:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> dBParameterGroups
A list of DBParameterGroup instances.
String dBParameterGroupName
The name of a specific DB parameter group to return details for.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
String source
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
com.amazonaws.internal.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.
com.amazonaws.internal.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.
com.amazonaws.internal.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.
com.amazonaws.internal.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 cannot be used in conjunction
with DBSnapshotIdentifier. This parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
String dBSnapshotIdentifier
A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with
DBInstanceIdentifier. This value is stored as a lowercase string.
Constraints:
Must be 1 to 255 alphanumeric characters.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
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.
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 setting the IncludeShared parameter to true. You can
include public snapshots with these results by setting the IncludePublic parameter to
true.
The IncludeShared and IncludePublic parameters don't apply for
SnapshotType values of manual or automated. The IncludePublic
parameter doesn't apply when SnapshotType is set to shared. The
IncludeShared parameter doesn't apply when SnapshotType is set to public.
com.amazonaws.internal.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
Set this value to true to include shared manual DB snapshots from other AWS accounts that this AWS
account has been given permission to copy or restore, otherwise set this value to false. The default
is false.
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
Set this value to true to include manual DB snapshots that are public and can be copied or restored
by any AWS account, otherwise set this value to false. The default is false.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
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.
com.amazonaws.internal.SdkInternalList<T> dBSnapshots
A list of DBSnapshot instances.
String dBSubnetGroupName
The name of the DB subnet group to return details for.
com.amazonaws.internal.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.
com.amazonaws.internal.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.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> filters
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 will be generating the events.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.SdkInternalList<T> filters
This parameter is not currently supported.
com.amazonaws.internal.SdkInternalList<T> eventCategoriesMapList
A list of EventCategoriesMap data types.
String sourceIdentifier
The identifier of the event source for which events will be 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.
Cannot end with a hyphen or contain two consecutive hyphens.
String sourceType
The event source to retrieve events for. If no value is specified, all events are returned.
Date startTime
The beginning of the time interval to retrieve events for, specified in ISO 8601 format. 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
com.amazonaws.internal.SdkInternalList<T> eventCategories
A list of event categories that trigger notifications for a event notification subscription.
com.amazonaws.internal.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 .
com.amazonaws.internal.SdkInternalList<T> events
A list of Event instances.
String subscriptionName
The name of the RDS event notification subscription you want to describe.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> eventSubscriptionsList
A list of EventSubscriptions data types.
String engineName
A required parameter. Options available for the given engine name will be described.
String majorEngineVersion
If specified, filters the results to include only options for the specified major engine version.
com.amazonaws.internal.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.
com.amazonaws.internal.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. Cannot be supplied together with EngineName or MajorEngineVersion.
com.amazonaws.internal.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.
com.amazonaws.internal.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
The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
com.amazonaws.internal.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 .
com.amazonaws.internal.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.
com.amazonaws.internal.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.
com.amazonaws.internal.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 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
The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.
com.amazonaws.internal.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.
com.amazonaws.internal.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
The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> reservedDBInstances
A list of reserved DB instances.
String regionName
The source 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.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> sourceRegions
A list of SourceRegion instances that contains each source AWS Region that the current region can get a Read Replica or a DB snapshot from.
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 contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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 will be 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 .
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> eventCategories
Specifies the category for the event.
Date dateValue
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
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> sourceIdsList
A list of source IDs for the RDS event notification subscription.
com.amazonaws.internal.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 contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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
This parameter is not currently supported.
com.amazonaws.internal.SdkInternalList<T> values
This parameter is not currently supported.
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 RDS Amazon Resource Name (ARN).
com.amazonaws.internal.SdkInternalList<T> filters
This parameter is not currently supported.
com.amazonaws.internal.SdkInternalList<T> tagList
List of tags returned by the ListTagsForResource operation.
String dBClusterParameterGroupName
The name of the DB cluster parameter group to modify.
com.amazonaws.internal.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 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
String dBClusterIdentifier
The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.
Constraints:
Must be the identifier for an existing DB cluster.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
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 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
Boolean applyImmediately
A value that specifies whether the 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 set to false, changes to the DB cluster are applied during the next
maintenance window.
The ApplyImmediately parameter only affects the NewDBClusterIdentifier and
MasterUserPassword values. If you set the ApplyImmediately parameter value to false,
then changes to the NewDBClusterIdentifier and MasterUserPassword values are applied
during the next maintenance window. All other changes are applied immediately, regardless of the value of the
ApplyImmediately parameter.
Default: false
Integer backupRetentionPeriod
The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
String dBClusterParameterGroupName
The name of the DB cluster parameter group to use for the DB cluster.
com.amazonaws.internal.SdkInternalList<T> vpcSecurityGroupIds
A lst 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 does not result in an outage except in the following case, and the change is applied during the next
maintenance window unless the ApplyImmediately parameter is set to true 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 cannot be removed from an option group. The option group cannot 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.
Default: A 30-minute window selected at random from an 8-hour block of time per 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.
Times should 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
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
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.
com.amazonaws.internal.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.
com.amazonaws.internal.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 be the identifier for an existing DB instance
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Integer allocatedStorage
The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change
is applied during the next maintenance window unless ApplyImmediately is set to true
for this request.
MySQL
Default: Uses existing setting
Valid Values: 5-6144
Constraints: 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.
Type: Integer
MariaDB
Default: Uses existing setting
Valid Values: 5-6144
Constraints: 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.
Type: Integer
PostgreSQL
Default: Uses existing setting
Valid Values: 5-6144
Constraints: 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.
Type: Integer
Oracle
Default: Uses existing setting
Valid Values: 10-6144
Constraints: 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.
SQL Server
Cannot be modified.
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 will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.
String dBInstanceClass
The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action. Note that not all instance classes are available in all regions for all DB engines.
Passing a value for this setting causes an outage during the change and is applied during the next maintenance
window, unless ApplyImmediately is specified as true for this request.
Default: Uses existing setting
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
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.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
window, unless you specify true for the ApplyImmediately parameter.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens.
Example: mySubnetGroup
com.amazonaws.internal.SdkInternalList<T> dBSecurityGroups
A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
com.amazonaws.internal.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.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Boolean applyImmediately
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.
If this parameter is set to false, changes to the DB instance are applied during the next
maintenance window. Some parameter changes can cause an outage and will be applied on the next call to
RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB
Instance and Using the Apply Immediately Parameter to see the impact that setting
ApplyImmediately to true or false has for each modified parameter and to
determine when the changes will be applied.
Default: false
String masterUserPassword
The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "@".
Changing this parameter does not 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.
Default: Uses existing setting
Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
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 does not 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 set to true 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.
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
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Cannot 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 does not result in an outage and the
change is asynchronously applied as soon as possible.
Constraints:
Must be in the format hh24:mi-hh24:mi
Times should 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 does not 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
Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and
the change is applied during the next maintenance window unless the ApplyImmediately parameter is
set to true for this request.
Constraints: Cannot be specified if the DB instance is a Read Replica.
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 set to
true for this request.
For major version upgrades, if a non-default 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 a list of valid engine versions, see CreateDBInstance.
Boolean allowMajorVersionUpgrade
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
Boolean autoMinorVersionUpgrade
Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance
window. Changing this parameter does not result in an outage except in the following case and the change is
asynchronously applied as soon as possible. An outage will result if this parameter is set to true
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 does not
result in an outage and the change is applied during the next maintenance window unless the
ApplyImmediately parameter is set to true for this request.
Default: Uses existing setting
Constraints: 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. 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.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
Type: Integer
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 will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.
String optionGroupName
Indicates that the DB instance should be associated with the specified option group. Changing this parameter does
not result in an outage except in the following case and the change is applied during the next maintenance window
unless the ApplyImmediately parameter is set to true 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, cannot be removed from an option group, and that option group cannot 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 will occur immediately if you set Apply Immediately to true, or will
occur during the next maintenance window if Apply Immediately to false. This value is stored as a
lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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 standard
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
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
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
Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to
make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address.
Set to False to make the DB instance internal 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 true in order for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the
ApplyImmediately parameter.
Default: false
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to 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.
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.
Default: 1
Valid Values: 0 - 15
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
Must be the name of an existing DB parameter group
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
com.amazonaws.internal.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.
com.amazonaws.internal.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.
com.amazonaws.internal.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 dBSubnetGroupName
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
String dBSubnetGroupDescription
The description for the DB subnet group.
com.amazonaws.internal.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 will be 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
com.amazonaws.internal.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 Boolean value; set to true to activate the subscription.
String optionGroupName
The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> optionsToRemove
Options in this list are removed from the option group.
Boolean applyImmediately
Indicates whether the changes should be applied 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.
com.amazonaws.internal.SdkInternalList<T> optionSettings
The option settings for this option.
com.amazonaws.internal.SdkInternalList<T> dBSecurityGroupMemberships
If the option requires access to a port, then this DB security group allows access to the port.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> dBSecurityGroupMemberships
A list of DBSecurityGroupMemebrship name strings used for this option.
com.amazonaws.internal.SdkInternalList<T> vpcSecurityGroupMemberships
A list of VpcSecurityGroupMemebrship name strings used for this option.
com.amazonaws.internal.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.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> optionsDependedOn
The options that are prerequisites for this option.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> optionGroupOptionSettings
The option settings that are available (and the default value) for each option in an option group.
com.amazonaws.internal.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.
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 the orderable DB instance.
String engineVersion
The engine version of the orderable DB instance.
String dBInstanceClass
The DB instance class for the orderable DB instance.
String licenseModel
The license model for the orderable DB instance.
com.amazonaws.internal.SdkInternalList<T> availabilityZones
A list of Availability Zones for the orderable DB instance.
Boolean multiAZCapable
Indicates whether this orderable DB instance is multi-AZ capable.
Boolean readReplicaCapable
Indicates whether this orderable DB instance can have a Read Replica.
Boolean vpc
Indicates whether this is a VPC orderable DB instance.
Boolean supportsStorageEncryption
Indicates whether this orderable DB instance supports encrypted storage.
String storageType
Indicates the storage type for this orderable DB instance.
Boolean supportsIops
Indicates whether this orderable DB instance supports provisioned IOPS.
Boolean supportsEnhancedMonitoring
Indicates whether the DB instance supports enhanced monitoring at intervals from 1 to 60 seconds.
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.
String action
The type of pending maintenance action that is available for the resource.
Date autoAppliedAfterDate
The date of the maintenance window when the action will be applied. The maintenance action will be applied to the
resource during its first maintenance window after this date. If this date is specified, any
next-maintenance opt-in requests are ignored.
Date forcedApplyDate
The date when the maintenance action will be automatically applied. The maintenance action will be applied to the
resource on this date regardless of the maintenance window for the resource. If this date is specified, any
immediate opt-in requests are ignored.
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 will be applied to the resource. This date takes into
account opt-in requests received from the ApplyPendingMaintenanceAction API, the
AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request
has not been received and nothing has been specified as AutoAppliedAfterDate or
ForcedApplyDate.
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 in progress.
Integer allocatedStorage
Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
String masterUserPassword
Contains the pending or 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 being applied.
String dBInstanceIdentifier
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
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.
String dBClusterIdentifier
The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-replica1
String dBInstanceIdentifier
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must be the identifier for an existing Read Replica DB instance
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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.
Default: A 30-minute window selected at random from an 8-hour block of time per 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.
Times should 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
com.amazonaws.internal.SdkInternalList<T> tags
String dBInstanceIdentifier
The DB instance identifier. 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
Cannot end with a hyphen or contain two consecutive hyphens
Boolean forceFailover
When true, the reboot will be conducted through a MultiAZ failover.
Constraint: You cannot specify true if the instance is not configured for MultiAZ.
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 the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
com.amazonaws.internal.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.
com.amazonaws.internal.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.
com.amazonaws.internal.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 is set to true to reset all parameters in the DB cluster parameter group to their
default values, and false otherwise. You cannot use this parameter if there is a list of parameter
names specified for the Parameters parameter.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this
parameter if the ResetAllParameters parameter is set to true.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Boolean resetAllParameters
Specifies whether (true) or not (false) to reset all parameters in the DB parameter
group to default values.
Default: true
com.amazonaws.internal.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.
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.
com.amazonaws.internal.SdkInternalList<T> pendingMaintenanceActionDetails
A list that provides details about the pending maintenance actions for the resource.
com.amazonaws.internal.SdkInternalList<T> availabilityZones
A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
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 S3 bucket. This parameter is isn't case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot 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 will be used.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
com.amazonaws.internal.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: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
String engine
The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora
String engineVersion
The version number of the database engine to use.
Aurora
Example: 5.6.10a
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 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
String masterUserPassword
The password for the master database user. This password can contain any printable ASCII character except "/", """, 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 cannot be removed from an option group. An option group cannot 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.
Default: A 30-minute window selected at random from an 8-hour block of time per 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.
Times should 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
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
com.amazonaws.internal.SdkInternalList<T> tags
Boolean storageEncrypted
Specifies whether the restored DB cluster is encrypted.
String kmsKeyId
The 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 true, 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 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.
com.amazonaws.internal.SdkInternalList<T> availabilityZones
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
String dBClusterIdentifier
The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
String snapshotIdentifier
The identifier for the DB cluster snapshot to restore from.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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: 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: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
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.
com.amazonaws.internal.SdkInternalList<T> vpcSecurityGroupIds
A list of VPC security groups that the new DB cluster will belong to.
com.amazonaws.internal.SdkInternalList<T> tags
The tags to be assigned to the restored DB cluster.
String kmsKeyId
The KMS key identifier to use when restoring an encrypted DB cluster from a 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 do not specify a value for the KmsKeyId parameter, then the following will occur:
If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot.
If the DB cluster snapshot is not encrypted, then the restored DB cluster is encrypted using the specified encryption key.
String dBClusterIdentifier
The name of the new DB cluster to be created.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
String sourceDBClusterIdentifier
The identifier of the source DB cluster from which to restore.
Constraints:
Must be the identifier of an existing database instance
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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
Cannot be specified if UseLatestRestorableTime parameter is true
Example: 2015-03-07T23:45:00Z
Boolean useLatestRestorableTime
A value that is set to true to restore the DB cluster to the latest restorable backup time, and
false otherwise.
Default: false
Constraints: Cannot be specified if RestoreToTime parameter is provided.
Integer port
The port number on which the new DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String dBSubnetGroupName
The DB subnet group name to use for the new DB cluster.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
String optionGroupName
The name of the option group for the new DB cluster.
com.amazonaws.internal.SdkInternalList<T> vpcSecurityGroupIds
A lst of VPC security groups that the new DB cluster belongs to.
com.amazonaws.internal.SdkInternalList<T> tags
String kmsKeyId
The 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 will be encrypted with the KMS key identified by
the KmsKeyId parameter.
If you do not specify a value for the KmsKeyId parameter, then the following will occur:
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 note encrypted, then the restore request is
rejected.
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 alphanumeric characters or hyphens (1 to 15 for SQL Server)
First character must be a letter
Cannot 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 contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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.
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
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 EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true.
Example: us-east-1a
String dBSubnetGroupName
The DB subnet group name to use for the new instance.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
Boolean multiAZ
Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true.
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.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
Boolean autoMinorVersionUpgrade
Indicates that minor version upgrades will be 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. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values: MySQL | mariadb | oracle-se1 | oracle-se |
oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex |
sqlserver-web | postgres | aurora
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 will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.
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, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
com.amazonaws.internal.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 standard
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 domain
Specify the Active Directory Domain to restore the instance in.
Boolean copyTagsToSnapshot
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
String domainIAMRoleName
Specify the name of the IAM role to be used when making API calls to the Directory Service.
String sourceDBInstanceIdentifier
The identifier of the source DB instance from which to restore.
Constraints:
Must be the identifier of an existing database instance
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
String targetDBInstanceIdentifier
The name of the new database instance to be created.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot 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
Cannot be specified if UseLatestRestorableTime parameter is true
Example: 2009-09-07T23:45:00Z
Boolean useLatestRestorableTime
Specifies whether (true) or not (false) the DB instance is restored from the latest
backup time.
Default: false
Constraints: Cannot be specified if RestoreTime parameter is provided.
String dBInstanceClass
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
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 EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
String dBSubnetGroupName
The DB subnet group name to use for the new instance.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
Boolean multiAZ
Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true.
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.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
Boolean autoMinorVersionUpgrade
Indicates that minor version upgrades will be 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: MySQL | mariadb | oracle-se1 | oracle-se |
oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex |
sqlserver-web | postgres | aurora
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, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
Boolean copyTagsToSnapshot
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
com.amazonaws.internal.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 standard
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 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.
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
cannot 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.
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 cannot be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
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 cannot be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
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 will be applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
Boolean isMajorVersionUpgrade
A value that indicates whether a database engine will be upgraded to a major version.
Copyright © 2017. All rights reserved.