String subscriptionName
String sourceIdentifier
Constraints:
DBInstanceIdentifier must be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must
be supplied.String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String resourceIdentifier
String applyAction
String optInType
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
String cIDRIP
String eC2SecurityGroupName
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId
must be provided.String eC2SecurityGroupId
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId
must be provided.String eC2SecurityGroupOwnerId
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
String certificateIdentifier
String certificateType
String thumbprint
Date validFrom
Date validTill
String sourceDBClusterSnapshotIdentifier
Constraints:
Example: my-cluster-snapshot1
String targetDBClusterSnapshotIdentifier
Constraints:
Example: my-cluster-snapshot2
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String sourceDBParameterGroupIdentifier
Constraints:
my-db-param-group, or a valid ARN.arn:aws:rds:us-west-2:123456789012:pg:special-parameters.String targetDBParameterGroupIdentifier
Constraints:
Example:
my-db-parameter-group
String targetDBParameterGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String sourceDBSnapshotIdentifier
If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot.
Constraints:
Example:
rds:mydb-2012-04-02-00-01
Example:
arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805
String targetDBSnapshotIdentifier
Constraints:
Example: my-db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Boolean copyTags
String sourceOptionGroupIdentifier
Constraints:
my-option-group, or a valid
ARN.arn:aws:rds:us-west-2:123456789012:og:special-options.String targetOptionGroupIdentifier
Constraints:
Example:
my-option-group
String targetOptionGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBClusterParameterGroupName
Constraints:
String dBParameterGroupFamily
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Integer backupRetentionPeriod
Default: 1
Constraints:
String characterSetName
String databaseName
String dBClusterIdentifier
Constraints:
Example: my-cluster1
String dBClusterParameterGroupName
default.aurora5.6
for the specified engine will be used. Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
String dBSubnetGroupName
String engine
Valid Values: aurora
String engineVersion
Aurora
Example: 5.6.10a
Integer port
Default: 3306
String masterUsername
Constraints:
String masterUserPassword
Constraints: Must contain from 8 to 41 characters.
String optionGroupName
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
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:
hh24:mi-hh24:mi.String preferredMaintenanceWindow
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.ListWithAutoConstructFlag<T> tags
Boolean storageEncrypted
String kmsKeyId
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 dBClusterSnapshotIdentifier
Constraints:
Example: my-cluster1-snapshot1
String dBClusterIdentifier
Constraints:
Example:
my-cluster1
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBInstanceIdentifier
String sourceDBInstanceIdentifier
Constraints:
String dBInstanceClass
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
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Integer port
Default: Inherits from the source DB instance
Valid Values:
1150-65535
Boolean autoMinorVersionUpgrade
Default: Inherits from the source DB instance
Integer iops
String optionGroupName
Boolean publiclyAccessible
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.
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.ListWithAutoConstructFlag<T> tags
String dBSubnetGroupName
Constraints:
String storageType
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
String dBName
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:
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:
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:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
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:
String dBInstanceIdentifier
Constraints:
Example:
mydbinstance
Integer allocatedStorage
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
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
Valid Values: MySQL | mariadb |
oracle-se1 | 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
MySQL
Constraints:
MariaDB
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
PostgreSQL
Constraints:
String masterUserPassword
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.ListWithAutoConstructFlag<T> dBSecurityGroups
Default: The default DB security group for the database engine.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default EC2 VPC security group for the DB subnet group's VPC.
String availabilityZone
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
If there is no DB subnet group, then it is a non-VPC DB instance.
String preferredMaintenanceWindow
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
Constraints:
Integer backupRetentionPeriod
Default: 1
Constraints:
String preferredBackupWindow
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:
hh24:mi-hh24:mi.Integer port
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
String engineVersion
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.
MySQL
5.1.73a | 5.1.73b 5.5.40 | 5.5.40a 5.5.40b | 5.5.41 | 5.5.42 5.6.19a |
5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23MariaDB
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
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 11.2.0.3.v1
| 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 |
11.2.0.4.v412.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
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 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 |
11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v412.1.0.1.v1 | 12.1.0.1.v2Oracle Database Standard Edition One (oracle-se1)
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 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 |
11.2.0.4.v3 | 11.2.0.4.v4 12.1.0.1.v1 | 12.1.0.1.v2PostgreSQL
9.3.1 |
9.3.2 9.3.3 | 9.3.5 | 9.3.6 | 9.3.9 | 9.3.10 9.4.1 |
9.4.4 | 9.4.5Microsoft SQL Server Enterprise Edition (sqlserver-ee)
10.50.2789.0.v1 10.50.6000.34.v1
11.00.2100.60.v1 11.00.5058.0.v1Microsoft SQL Server Express Edition (sqlserver-ex)
10.50.2789.0.v1 10.50.6000.34.v1 11.00.2100.60.v1
11.00.5058.0.v1 12.00.4422.0.v1Microsoft SQL Server Standard Edition (sqlserver-se)
10.50.2789.0.v1 10.50.6000.34.v1 11.00.2100.60.v1
11.00.5058.0.v1 12.00.4422.0.v1Microsoft SQL Server Web Edition (sqlserver-web)
10.50.2789.0.v1
10.50.6000.34.v1 11.00.2100.60.v1 11.00.5058.0.v1
12.00.4422.0.v1Boolean autoMinorVersionUpgrade
Default:
true
String licenseModel
Valid values:
license-included | bring-your-own-license |
general-public-license
Integer iops
Constraints: To use PIOPS, this value must be an integer greater than 1000.
String optionGroupName
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
Boolean publiclyAccessible
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.
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.ListWithAutoConstructFlag<T> tags
String dBClusterIdentifier
For information on creating a DB cluster, see CreateDBCluster.
Type: String
String storageType
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
String tdeCredentialPassword
Boolean storageEncrypted
Default: false
String kmsKeyId
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.
Boolean copyTagsToSnapshot
String dBParameterGroupName
Constraints:
String dBParameterGroupFamily
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSecurityGroupName
Constraints:
Example: mysecuritygroup
String dBSecurityGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSnapshotIdentifier
Constraints:
Example: my-snapshot-id
String dBInstanceIdentifier
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, or hyphens. Must not be default.
Example: mySubnetgroup
String dBSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String subscriptionName
Constraints: The name must be less than 255 characters.
String snsTopicArn
String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIds
Constraints:
DBInstanceIdentifier must
be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must
be supplied.Boolean enabled
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String optionGroupName
Constraints:
Example:
myoptiongroup
String engineName
String majorEngineVersion
String optionGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Integer allocatedStorage
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Integer backupRetentionPeriod
String characterSetName
String databaseName
String dBClusterIdentifier
String dBClusterParameterGroup
String dBSubnetGroup
String status
String percentProgress
Date earliestRestorableTime
String endpoint
String engine
String engineVersion
Date latestRestorableTime
Integer port
String masterUsername
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusterOptionGroupMemberships
String preferredBackupWindow
BackupRetentionPeriod.String preferredMaintenanceWindow
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusterMembers
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
String hostedZoneId
Boolean storageEncrypted
String kmsKeyId
StorageEncrypted is true, the KMS key identifier for
the encrypted DB cluster.String dbClusterResourceId
StorageEncrypted is true, the region-unique, immutable
identifier for the encrypted DB cluster. This identifier is found in
AWS CloudTrail log entries whenever the KMS key for the DB cluster is
accessed.String dBInstanceIdentifier
Boolean isClusterWriter
true if the cluster member is the primary
instance for the DB cluster and false otherwise.String dBClusterParameterGroupStatus
String dBClusterParameterGroupName
String dBParameterGroupFamily
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String dBClusterSnapshotIdentifier
String dBClusterIdentifier
Date snapshotCreateTime
String engine
Integer allocatedStorage
String status
Integer port
String vpcId
Date clusterCreateTime
String masterUsername
String engineVersion
String licenseModel
String snapshotType
Integer percentProgress
Boolean storageEncrypted
String kmsKeyId
StorageEncrypted is true, the KMS key identifier for
the encrypted DB cluster snapshot.String engine
String engineVersion
String dBParameterGroupFamily
String dBEngineDescription
String dBEngineVersionDescription
CharacterSet defaultCharacterSet
CharacterSetName parameter of the CreateDBInstance
API is not specified.com.amazonaws.internal.ListWithAutoConstructFlag<T> supportedCharacterSets
CharacterSetName parameter of the CreateDBInstance API.com.amazonaws.internal.ListWithAutoConstructFlag<T> validUpgradeTarget
String dBInstanceIdentifier
String dBInstanceClass
String engine
String dBInstanceStatus
String masterUsername
String dBName
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
Integer allocatedStorage
Date instanceCreateTime
String preferredBackupWindow
BackupRetentionPeriod.Integer backupRetentionPeriod
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBParameterGroups
String availabilityZone
DBSubnetGroup dBSubnetGroup
String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
Date latestRestorableTime
Boolean multiAZ
String engineVersion
Boolean autoMinorVersionUpgrade
String readReplicaSourceDBInstanceIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> readReplicaDBInstanceIdentifiers
String licenseModel
Integer iops
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupMemberships
String characterSetName
String secondaryAvailabilityZone
Boolean publiclyAccessible
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.
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.ListWithAutoConstructFlag<T> statusInfos
String storageType
String tdeCredentialArn
Integer dbInstancePort
String dBClusterIdentifier
Boolean storageEncrypted
String kmsKeyId
StorageEncrypted is true, the KMS key identifier for
the encrypted DB instance.String dbiResourceId
StorageEncrypted is true, the region-unique, immutable
identifier for the encrypted DB instance. This identifier is found in
AWS CloudTrail log entries whenever the KMS key for the DB instance is
accessed.String cACertificateIdentifier
Boolean copyTagsToSnapshot
String statusType
Boolean normal
String status
String message
String dBParameterGroupName
String dBParameterGroupFamily
String description
String ownerId
String dBSecurityGroupName
String dBSecurityGroupDescription
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> iPRanges
String dBSnapshotIdentifier
String dBInstanceIdentifier
Date snapshotCreateTime
String engine
Integer allocatedStorage
String status
Integer port
String availabilityZone
String vpcId
Date instanceCreateTime
String masterUsername
String engineVersion
String licenseModel
String snapshotType
Integer iops
String optionGroupName
Integer percentProgress
String sourceRegion
String sourceDBSnapshotIdentifier
String storageType
String tdeCredentialArn
Boolean encrypted
String kmsKeyId
Encrypted is true, the KMS key identifier for the
encrypted DB snapshot.String attributeName
An attribute name of
restore applies to the list of AWS accounts that have
permission to copy or restore the manual DB snapshot.
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValues
If the
AttributeName field is restore, then this
field returns a list of AWS account ids 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
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSnapshotAttributes
String dBSubnetGroupName
String dBSubnetGroupDescription
String vpcId
String subnetGroupStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String dBClusterParameterGroupName
Constraints:
String dBClusterIdentifier
Constraints:
Boolean skipFinalSnapshot
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.
FinalDBSnapshotIdentifier
parameter if SkipFinalSnapshot is
false.Default: false
String finalDBSnapshotIdentifier
SkipFinalSnapshot is set to
false. SkipFinalShapshot parameter to true results in an
error. Constraints:
String dBClusterSnapshotIdentifier
Constraints:
Must be the name of an existing DB cluster snapshot in the
available state.
String dBInstanceIdentifier
Constraints:
Boolean skipFinalSnapshot
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. false.
Default:
false
String finalDBSnapshotIdentifier
false. Constraints:
String dBParameterGroupName
Constraints:
String dBSecurityGroupName
Constraints:
String dBSnapshotIdentifier
Constraints: Must be the name of an
existing DB snapshot in the available state.
String dBSubnetGroupName
Constraints:
String subscriptionName
String optionGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> accountQuotas
String certificateIdentifier
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> certificates
String marker
MaxRecords .String dBClusterParameterGroupName
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
DescribeDBClusterParameterGroups request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.String marker
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.ListWithAutoConstructFlag<T> dBClusterParameterGroups
String dBClusterParameterGroupName
Constraints:
String source
engine,
service, or customer.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
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.ListWithAutoConstructFlag<T> parameters
String marker
MaxRecords .String dBClusterIdentifier
DBClusterSnapshotIdentifier parameter. This parameter is
not case-sensitive. Constraints:
String dBClusterSnapshotIdentifier
DBClusterIdentifier parameter. This value is stored as a
lowercase string. Constraints:
SnapshotType parameter must also be specified.String snapshotType
automated or manual. If this parameter is
not specified, the returned results will include all snapshot types.com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
DescribeDBClusterSnapshots request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusterSnapshots
String dBClusterIdentifier
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
MaxRecords.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusters
String engine
String engineVersion
Example: 5.1.49
String dBParameterGroupFamily
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
MaxRecords.Boolean defaultOnly
Boolean listSupportedCharacterSets
String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBEngineVersions
DBEngineVersion elements.String dBInstanceIdentifier
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
DescribeDBInstances request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.String marker
MaxRecords .com.amazonaws.internal.ListWithAutoConstructFlag<T> dBInstances
String dBInstanceIdentifier
Constraints:
String filenameContains
Long fileLastWritten
Long fileSize
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> describeDBLogFiles
String marker
String dBParameterGroupName
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
DescribeDBParameterGroups request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBParameterGroups
String dBParameterGroupName
Constraints:
String source
Default: All parameter types returned
Valid Values: user | system | engine-default
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
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.ListWithAutoConstructFlag<T> parameters
String marker
MaxRecords.String dBSecurityGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
DescribeDBSecurityGroups request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
String dBSnapshotIdentifier
String dBInstanceIdentifier
DBSnapshotIdentifier. This parameter is not
case-sensitive. Constraints:
String dBSnapshotIdentifier
DBInstanceIdentifier. This
value is stored as a lowercase string. Constraints:
SnapshotType parameter must also be specified.String snapshotType
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 do not specify a
SnapshotType, then both automated and manual snapshots
are returned. 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
do not apply for SnapshotType values of
manual or automated. The
IncludePublic parameter does not apply when
SnapshotType is set to shared. the
IncludeShared parameter does not apply when
SnapshotType is set to public.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
DescribeDBSnapshots request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.Boolean includeShared
An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.
Boolean includePublic
An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.
String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSnapshots
String dBSubnetGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
MaxRecords.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSubnetGroups
String dBParameterGroupFamily
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
DescribeEngineDefaultClusterParameters request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.String dBParameterGroupFamily
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
DescribeEngineDefaultParameters request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesMapList
String sourceIdentifier
Constraints:
DBInstance, then a DBInstanceIdentifier must
be supplied.DBSecurityGroup, a DBSecurityGroupName must
be supplied.DBParameterGroup, a DBParameterGroupName
must be supplied.DBSnapshot, a DBSnapshotIdentifier must be
supplied.String sourceType
Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
Date startTime
Example: 2009-07-08T18:00Z
Date endTime
Example: 2009-07-08T18:00Z
Integer duration
Default: 60
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
MaxRecords.String marker
MaxRecords .com.amazonaws.internal.ListWithAutoConstructFlag<T> events
String subscriptionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
MaxRecords .String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> eventSubscriptionsList
String engineName
String majorEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupOptions
String marker
MaxRecords.String optionGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String marker
MaxRecords.Integer maxRecords
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
String majorEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupsList
String marker
MaxRecords.String engine
String engineVersion
String dBInstanceClass
String licenseModel
Boolean vpc
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
MaxRecords .com.amazonaws.internal.ListWithAutoConstructFlag<T> orderableDBInstanceOptions
String marker
MaxRecords .String resourceIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Supported filters:
db-instance-id - Accepts DB instance identifiers and DB
instance Amazon Resource Names (ARNs). The results list will only
include pending maintenance actions for the DB instances identified by
these ARNs.String marker
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
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.ListWithAutoConstructFlag<T> pendingMaintenanceActions
String marker
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
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
String dBInstanceClass
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Partial Upfront" | "All Upfront" | "No Upfront"
Boolean multiAZ
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
MaxRecords.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedDBInstancesOfferings
String reservedDBInstanceId
String reservedDBInstancesOfferingId
String dBInstanceClass
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Partial Upfront" | "All Upfront" | "No Upfront"
Boolean multiAZ
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Integer maxRecords
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
MaxRecords.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedDBInstances
String dBInstanceIdentifier
Constraints:
String logFileName
String marker
Integer numberOfLines
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.
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
String marker
Boolean additionalDataPending
String status
String eC2SecurityGroupName
String eC2SecurityGroupId
String eC2SecurityGroupOwnerId
EC2SecurityGroupName field.String dBParameterGroupFamily
String marker
MaxRecords .com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String sourceIdentifier
String sourceType
Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
String message
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Date date
String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
String customerAwsId
String custSubscriptionId
String snsTopicArn
String status
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
String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIdsList
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesList
Boolean enabled
String dBClusterIdentifier
Constraints:
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
String dBClusterParameterGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
String dBClusterParameterGroupName
Constraints:
String dBClusterIdentifier
Constraints:
String newDBClusterIdentifier
Constraints:
Example: my-cluster2
Boolean applyImmediately
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.
Default: false
Integer backupRetentionPeriod
Default: 1
Constraints:
String dBClusterParameterGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Integer port
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String masterUserPassword
Constraints: Must contain from 8 to 41 characters.
String optionGroupName
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
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:
hh24:mi-hh24:mi.String preferredMaintenanceWindow
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 dBInstanceIdentifier
Constraints:
Integer allocatedStorage
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
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Constraints:
Boolean applyImmediately
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
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).
String dBParameterGroupName
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
Integer backupRetentionPeriod
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:
String preferredBackupWindow
BackupRetentionPeriod parameter. Changing this parameter
does not result in an outage and the change is asynchronously applied
as soon as possible. Constraints:
String preferredMaintenanceWindow
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
ApplyImmediately parameter is set to true
for this request. Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.
String engineVersion
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
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
true during the
maintenance window, and a newer minor version is available, and RDS
has enabled auto patching for that engine version.Integer iops
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
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
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:
String storageType
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
String tdeCredentialPassword
String cACertificateIdentifier
Boolean copyTagsToSnapshot
Integer dBPortNumber
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
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
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 dBParameterGroupName
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Valid Values (for
the application method): immediate | pending-reboot
String dBParameterGroupName
String dBSnapshotIdentifier
String attributeName
To manage
authorization for other AWS accounts to copy or restore a manual DB
snapshot, this value is restore.
com.amazonaws.internal.ListWithAutoConstructFlag<T> valuesToAdd
AttributeName. To authorize other AWS Accounts to copy
or restore a manual snapshot, this is one or more AWS account
identifiers, 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
do not want to be available to all AWS accounts.
com.amazonaws.internal.ListWithAutoConstructFlag<T> valuesToRemove
AttributeName. To remove authorization
for other AWS Accounts to copy or restore a manual snapshot, this is
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, AWS accounts that have their account
identifier explicitly added to the restore attribute can
still copy or restore the manual DB snapshot.
String dBSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
Example:
mySubnetgroup
String dBSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
String subscriptionName
String snsTopicArn
String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Boolean enabled
String optionGroupName
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.ListWithAutoConstructFlag<T> optionsToInclude
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
Boolean applyImmediately
String optionName
String optionDescription
Boolean persistent
Boolean permanent
Integer port
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
String optionName
Integer port
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
String optionGroupName
String optionGroupDescription
String engineName
String majorEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> options
Boolean allowsVpcAndNonVpcInstanceMemberships
true indicates the option
group can be applied to both VPC and non-VPC instances.String vpcId
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 name
String description
String engineName
String majorEngineVersion
String minimumRequiredMinorEngineVersion
Boolean portRequired
Integer defaultPort
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsDependedOn
Boolean persistent
Boolean permanent
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupOptionSettings
String settingName
String settingDescription
String defaultValue
String applyType
String allowedValues
Boolean isModifiable
String name
String value
String defaultValue
String description
String applyType
String dataType
String allowedValues
Boolean isModifiable
Boolean isCollection
String engine
String engineVersion
String dBInstanceClass
String licenseModel
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Boolean multiAZCapable
Boolean readReplicaCapable
Boolean vpc
Boolean supportsStorageEncryption
String storageType
Boolean supportsIops
String parameterName
String parameterValue
String description
String source
String applyType
String dataType
String allowedValues
Boolean isModifiable
true) or not (false) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.String minimumEngineVersion
String applyMethod
Constraints:
Allowed Values: immediate, pending-reboot
String action
Date autoAppliedAfterDate
next-maintenance opt-in requests are ignored.Date forcedApplyDate
immediate opt-in requests are ignored.String optInStatus
Date currentApplyDate
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
String dBInstanceClass
DBInstanceClass for the DB instance that
will be applied or is in progress.Integer allocatedStorage
AllocatedStorage size for the DB
instance that will be applied or is in progress.String masterUserPassword
Integer port
Integer backupRetentionPeriod
Boolean multiAZ
String engineVersion
Integer iops
String dBInstanceIdentifier
DBInstanceIdentifier for the DB instance
that will be applied or is in progress.String storageType
String cACertificateIdentifier
String dBInstanceIdentifier
Constraints:
Example: mydbinstance
Integer backupRetentionPeriod
Default: 1
Constraints:
String preferredBackupWindow
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:
hh24:mi-hh24:mi.String reservedDBInstancesOfferingId
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String reservedDBInstanceId
Example: myreservationID
Integer dBInstanceCount
Default: 1
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String dBInstanceIdentifier
Constraints:
Boolean forceFailover
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
String sourceIdentifier
String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
String reservedDBInstanceId
String reservedDBInstancesOfferingId
String dBInstanceClass
Date startTime
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
Integer dBInstanceCount
String productDescription
String offeringType
Boolean multiAZ
String state
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String reservedDBInstancesOfferingId
String dBInstanceClass
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
String productDescription
String offeringType
Boolean multiAZ
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String dBClusterParameterGroupName
Boolean resetAllParameters
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.ListWithAutoConstructFlag<T> parameters
ResetAllParameters parameter is set to true.String dBClusterParameterGroupName
Constraints:
String dBParameterGroupName
Constraints:
Boolean resetAllParameters
true) or not (false) to
reset all parameters in the DB parameter group to default values.
Default: true
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
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
String resourceIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> pendingMaintenanceActionDetails
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String dBClusterIdentifier
Constraints:
Example:
my-snapshot-id
String snapshotIdentifier
Constraints:
String engine
Default: The same as source
Constraint: Must be compatible with the engine of the source
String engineVersion
Integer port
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String dBSubnetGroupName
String databaseName
String optionGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String kmsKeyId
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.
String dBClusterIdentifier
Constraints:
String sourceDBClusterIdentifier
Constraints:
Date restoreToTime
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
UseLatestRestorableTime parameter is trueExample: 2015-03-07T23:45:00Z
Boolean useLatestRestorableTime
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
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String dBSubnetGroupName
String optionGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String kmsKeyId
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.
String dBInstanceIdentifier
Constraints:
Example:
my-snapshot-id
String dBSnapshotIdentifier
Constraints:
If you
are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier must be the ARN of the shared DB
snapshot.
String dBInstanceClass
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
Default: The same port as the original DB instance
Constraints: Value must
be 1150-65535
String availabilityZone
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
Boolean multiAZ
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true.
Boolean publiclyAccessible
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.
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
String licenseModel
Default: Same as source.
Valid values: license-included |
bring-your-own-license |
general-public-license
String dBName
This parameter doesn't apply to the MySQL or MariaDB engines.
String engine
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
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
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.ListWithAutoConstructFlag<T> tags
String storageType
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
String tdeCredentialPassword
Boolean copyTagsToSnapshot
String sourceDBInstanceIdentifier
Constraints:
String targetDBInstanceIdentifier
Constraints:
Date restoreTime
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Example: 2009-09-07T23:45:00Z
Boolean useLatestRestorableTime
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
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
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
String availabilityZone
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
Boolean multiAZ
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true.
Boolean publiclyAccessible
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.
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
String licenseModel
Default: Same as source.
Valid values: license-included |
bring-your-own-license |
general-public-license
String dBName
This parameter is not used for the MySQL or MariaDB engines.
String engine
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
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
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String storageType
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
String tdeCredentialPassword
String dBSecurityGroupName
String cIDRIP
CIDRIP is specified, EC2SecurityGroupName,
EC2SecurityGroupId and
EC2SecurityGroupOwnerId cannot be provided.String eC2SecurityGroupName
EC2SecurityGroupId must be provided.
Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId
must be provided.String eC2SecurityGroupId
EC2SecurityGroupId must be provided.
Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId
must be provided.String eC2SecurityGroupOwnerId
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
AvailabilityZone subnetAvailabilityZone
This data type is used as an element in the following data type:
String subnetStatus
String key
String value
String engine
String engineVersion
String description
Boolean autoUpgrade
Boolean isMajorVersionUpgrade
Copyright © 2015. All rights reserved.