String subscriptionName
String sourceIdentifier
Constraints:
DBInstanceIdentifier must be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must
be supplied.String resourceName
ListWithAutoConstructFlag<T> tags
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
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId must be provided.String name
String sourceDBParameterGroupIdentifier
Constraints:
Example: my-db-param-group
Example:
arn:aws:rds:us-west-2:123456789012:pg:special-parameters
String targetDBParameterGroupIdentifier
Constraints:
Example:
my-db-parameter-group
String targetDBParameterGroupDescription
ListWithAutoConstructFlag<T> tags
String sourceDBSnapshotIdentifier
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
ListWithAutoConstructFlag<T> tags
String sourceOptionGroupIdentifier
Constraints:
Example: my-option-group
Example:
arn:aws:rds:us-west-2:123456789012:og:special-options
String targetOptionGroupIdentifier
Constraints:
Example:
my-option-group
String targetOptionGroupDescription
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.r3.large |
db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge |
db.t2.micro | db.t2.small | db.t2.medium
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.
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.
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:
PostgreSQL
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:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
SQL Server
Not applicable. Must be null.
String dBInstanceIdentifier
Constraints:
Example:
mydbinstance
Integer allocatedStorage
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 3072.
PostgreSQL
Constraints: Must be an integer from 5 to 3072.
Oracle
Constraints: Must be an integer from 10 to 3072.
SQL Server
Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 30 to 1024 (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.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
String engine
Valid Values: MySQL | oracle-se1 |
oracle-se | oracle-ee |
sqlserver-ee | sqlserver-se |
sqlserver-ex | sqlserver-web |
postgres
String masterUsername
MySQL
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
String masterUserPassword
Type: String
MySQL
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.
ListWithAutoConstructFlag<T> dBSecurityGroups
Default: The default DB security group for the database engine.
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. Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.
Constraints: Must
be in the format hh24:mi-hh24:mi. Times should be
Universal Time Coordinated (UTC). Must not conflict with the preferred
maintenance window. Must be at least 30 minutes.
Integer port
MySQL
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.
Boolean multiAZ
String engineVersion
MySQL
Example: 5.1.42
Type: String
PostgreSQL
Example: 9.3
Type: String
Oracle
Example: 11.2.0.2.v2
Type: String
SQL Server
Example: 10.50.2789.0.v1
Boolean 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.
ListWithAutoConstructFlag<T> tags
String storageType
Valid values: standard | gp2 | io1
If you specify
io1, you must also include a value for the
Iops parameter.
String tdeCredentialArn
String tdeCredentialPassword
String dBParameterGroupName
Constraints:
String dBParameterGroupFamily
String description
ListWithAutoConstructFlag<T> tags
String dBSecurityGroupName
Constraints:
Example: mysecuritygroup
String dBSecurityGroupDescription
ListWithAutoConstructFlag<T> tags
String dBSnapshotIdentifier
Constraints:
Example: my-snapshot-id
String dBInstanceIdentifier
Constraints:
ListWithAutoConstructFlag<T> tags
String dBSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
Example:
mySubnetgroup
String dBSubnetGroupDescription
ListWithAutoConstructFlag<T> subnetIds
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
ListWithAutoConstructFlag<T> eventCategories
ListWithAutoConstructFlag<T> sourceIds
Constraints:
DBInstanceIdentifier must
be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must
be supplied.Boolean enabled
ListWithAutoConstructFlag<T> tags
String optionGroupName
Constraints:
Example:
myoptiongroup
String engineName
String majorEngineVersion
String optionGroupDescription
ListWithAutoConstructFlag<T> tags
String engine
String engineVersion
String dBParameterGroupFamily
String dBEngineDescription
String dBEngineVersionDescription
CharacterSet defaultCharacterSet
CharacterSetName parameter of the CreateDBInstance
API is not specified.ListWithAutoConstructFlag<T> supportedCharacterSets
CharacterSetName parameter of the CreateDBInstance API.String dBInstanceIdentifier
String dBInstanceClass
String engine
String dBInstanceStatus
String masterUsername
String dBName
MySQL
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
ListWithAutoConstructFlag<T> dBSecurityGroups
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.ListWithAutoConstructFlag<T> vpcSecurityGroups
ListWithAutoConstructFlag<T> dBParameterGroups
String availabilityZone
DBSubnetGroup dBSubnetGroup
String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
Date latestRestorableTime
Boolean multiAZ
String engineVersion
Boolean autoMinorVersionUpgrade
String readReplicaSourceDBInstanceIdentifier
ListWithAutoConstructFlag<T> readReplicaDBInstanceIdentifiers
String licenseModel
Integer iops
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.
ListWithAutoConstructFlag<T> statusInfos
String storageType
String tdeCredentialArn
String statusType
Boolean normal
String status
String message
String dBParameterGroupName
String dBParameterGroupFamily
String description
String ownerId
String dBSecurityGroupName
String dBSecurityGroupDescription
String vpcId
ListWithAutoConstructFlag<T> eC2SecurityGroups
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 storageType
String tdeCredentialArn
String dBSubnetGroupName
String dBSubnetGroupDescription
String vpcId
String subnetGroupStatus
ListWithAutoConstructFlag<T> subnets
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. 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
String engine
String engineVersion
Example: 5.1.49
String dBParameterGroupFamily
Constraints:
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.ListWithAutoConstructFlag<T> dBEngineVersions
DBEngineVersion elements.String dBInstanceIdentifier
Constraints:
ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords .String marker
MaxRecords .ListWithAutoConstructFlag<T> dBInstances
String dBInstanceIdentifier
Constraints:
String filenameContains
Long fileLastWritten
Long fileSize
ListWithAutoConstructFlag<T> filters
Integer maxRecords
String marker
ListWithAutoConstructFlag<T> describeDBLogFiles
String marker
String dBParameterGroupName
Constraints:
ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may 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.ListWithAutoConstructFlag<T> dBParameterGroups
String dBParameterGroupName
Constraints:
String source
Default: All parameter types returned
Valid Values: user | system | engine-default
ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may 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.ListWithAutoConstructFlag<T> parameters
String marker
MaxRecords.String dBSecurityGroupName
ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords.String marker
MaxRecords.ListWithAutoConstructFlag<T> dBSecurityGroups
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
ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may 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.String marker
MaxRecords.ListWithAutoConstructFlag<T> dBSnapshots
String dBSubnetGroupName
ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords.String marker
MaxRecords.ListWithAutoConstructFlag<T> dBSubnetGroups
String dBParameterGroupFamily
ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may 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
ListWithAutoConstructFlag<T> filters
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
Date startTime
Example: 2009-07-08T18:00Z
Date endTime
Example: 2009-07-08T18:00Z
Integer duration
Default: 60
ListWithAutoConstructFlag<T> eventCategories
ListWithAutoConstructFlag<T> filters
Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
String marker
MaxRecords.String marker
MaxRecords .ListWithAutoConstructFlag<T> events
String subscriptionName
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.ListWithAutoConstructFlag<T> eventSubscriptionsList
String engineName
String majorEngineVersion
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.ListWithAutoConstructFlag<T> optionGroupOptions
String marker
MaxRecords.String optionGroupName
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
ListWithAutoConstructFlag<T> optionGroupsList
String marker
MaxRecords.String engine
String engineVersion
String dBInstanceClass
String licenseModel
Boolean vpc
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 .ListWithAutoConstructFlag<T> orderableDBInstanceOptions
String marker
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: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
Boolean multiAZ
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.ListWithAutoConstructFlag<T> reservedDBInstancesOfferings
String reservedDBInstanceId
String reservedDBInstancesOfferingId
String dBInstanceClass
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
Boolean multiAZ
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.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 .ListWithAutoConstructFlag<T> parameters
String sourceIdentifier
String sourceType
Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot
String message
ListWithAutoConstructFlag<T> eventCategories
Date date
String sourceType
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
ListWithAutoConstructFlag<T> sourceIdsList
ListWithAutoConstructFlag<T> eventCategoriesList
Boolean enabled
String name
ListWithAutoConstructFlag<T> values
String resourceName
ListWithAutoConstructFlag<T> filters
ListWithAutoConstructFlag<T> tagList
String dBInstanceIdentifier
Constraints:
Integer allocatedStorage
ApplyImmediately is set to
true for this request. MySQL
Default: Uses existing setting
Valid Values: 5-3072
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-3072
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-3072
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 may 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.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
ListWithAutoConstructFlag<T> dBSecurityGroups
Constraints:
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), 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. 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.
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.
Example:
5.1.42
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 may 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.
String tdeCredentialArn
String tdeCredentialPassword
String dBParameterGroupName
Constraints:
ListWithAutoConstructFlag<T> parameters
Valid Values (for
the application method): immediate | pending-reboot
String dBParameterGroupName
String dBSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
Example:
mySubnetgroup
String dBSubnetGroupDescription
ListWithAutoConstructFlag<T> subnetIds
String subscriptionName
String snsTopicArn
String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
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
ListWithAutoConstructFlag<T> optionsToInclude
ListWithAutoConstructFlag<T> optionsToRemove
Boolean applyImmediately
String optionName
String optionDescription
Boolean persistent
Boolean permanent
Integer port
ListWithAutoConstructFlag<T> optionSettings
ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
String optionName
Integer port
ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
ListWithAutoConstructFlag<T> optionSettings
String optionGroupName
String optionGroupDescription
String engineName
String majorEngineVersion
ListWithAutoConstructFlag<T> options
Boolean allowsVpcAndNonVpcInstanceMemberships
String vpcId
String name
String description
String engineName
String majorEngineVersion
String minimumRequiredMinorEngineVersion
Boolean portRequired
Integer defaultPort
ListWithAutoConstructFlag<T> optionsDependedOn
Boolean persistent
Boolean permanent
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
ListWithAutoConstructFlag<T> availabilityZones
Boolean multiAZCapable
Boolean readReplicaCapable
Boolean vpc
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 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 dBInstanceIdentifier
Constraints:
Example:
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. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.
Constraints: Must
be in the format hh24:mi-hh24:mi. Times should be
Universal Time Coordinated (UTC). Must not conflict with the preferred
maintenance window. Must be at least 30 minutes.
String reservedDBInstancesOfferingId
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String reservedDBInstanceId
Example: myreservationID
Integer dBInstanceCount
Default: 1
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
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
ListWithAutoConstructFlag<T> recurringCharges
String reservedDBInstancesOfferingId
String dBInstanceClass
Integer duration
Double fixedPrice
Double usagePrice
String currencyCode
String productDescription
String offeringType
Boolean multiAZ
ListWithAutoConstructFlag<T> recurringCharges
String dBParameterGroupName
Constraints:
Boolean resetAllParameters
true) or not (false) to
reset all parameters in the DB parameter group to default values.
Default: true
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.
Oracle
Valid Values (for Apply
method): pending-reboot
String dBParameterGroupName
String dBInstanceIdentifier
Constraints:
Example: my-snapshot-id
String dBSnapshotIdentifier
Constraints:
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.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
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 engine.
String engine
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
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
ListWithAutoConstructFlag<T> tags
String storageType
Valid values: standard | gp2 | io1
If you specify
io1, you must also include a value for the
Iops parameter.
String tdeCredentialArn
String tdeCredentialPassword
String sourceDBInstanceIdentifier
Constraints:
String targetDBInstanceIdentifier
Constraints:
Date restoreTime
Valid Values: Value must be a UTC time
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.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
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 engine.
String engine
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
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
ListWithAutoConstructFlag<T> tags
String storageType
Valid values: standard | gp2 | io1
If you specify
io1, you must also include a value for the
Iops parameter.
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
Copyright © 2014. All rights reserved.