String requestId
String dbInstanceIdentifier
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
String dbInstanceClass
Contains the name of the compute and memory capacity class of the DB instance.
String engine
Provides the name of the database engine to be used for this DB instance.
String dbInstanceStatus
Specifies the current state of this database.
String masterUsername
Contains the master username for the DB instance.
String dbName
The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint endpoint
Specifies the connection endpoint.
Integer allocatedStorage
Specifies the allocated storage size specified in gigabytes.
LocalDateTime instanceCreateTime
Provides the date and time the DB instance was created.
String preferredBackupWindow
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod.
Integer backupRetentionPeriod
Specifies the number of days for which automatic DB snapshots are retained.
List<E> dbSecurityGroups
Provides List of DB security group elements containing only DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.
List<E> vpcSecurityGroups
Provides a list of VPC security group elements that the DB instance belongs to.
List<E> dbParameterGroups
Provides the list of DB parameter groups applied to this DB instance.
String availabilityZone
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup dbSubnetGroup
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
String preferredMaintenanceWindow
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues pendingModifiedValues
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
LocalDateTime latestRestorableTime
Specifies the latest time to which a database can be restored with point-in-time restore.
boolean multiAZ
Specifies if the DB instance is a Multi-AZ deployment.
String engineVersion
Indicates the database engine version.
boolean autoMinorVersionUpgrade
Indicates that minor version patches are applied automatically.
String readReplicaSourceDBInstanceIdentifier
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
List<E> readReplicaDBInstanceIdentifiers
Contains one or more identifiers of the Read Replicas associated with this DB instance.
List<E> readReplicaDBClusterIdentifiers
Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
String licenseModel
License model information for this DB instance.
Integer iops
Specifies the Provisioned IOPS (I/O operations per second) value.
List<E> optionGroupMemberships
Provides the list of option group memberships for this DB instance.
String characterSetName
If present, specifies the name of the character set that this instance is associated with.
String secondaryAvailabilityZone
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
boolean publiclyAccessible
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
List<E> statusInfos
The status of a Read Replica. If the instance is not a Read Replica, this will be blank.
String storageType
Specifies the storage type associated with DB instance.
String tdeCredentialArn
The ARN from the key store with which the instance is associated for TDE encryption.
Integer dbInstancePort
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
String dbClusterIdentifier
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
boolean storageEncrypted
Specifies whether the DB instance is encrypted.
String kmsKeyId
If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.
String dbiResourceId
The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
String caCertificateIdentifier
The identifier of the CA certificate for this DB instance.
List<E> domainMemberships
The Active Directory Domain membership records associated with the DB instance.
boolean copyTagsToSnapshot
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
String enhancedMonitoringResourceArn
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
Integer promotionTier
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
String dbInstanceArn
The Amazon Resource Name (ARN) for the DB instance.
String timezone
The time zone of the DB instance. In most cases, the Timezone element is empty.
Timezone content appears only for Microsoft SQL Server DB instances that were created with a time
zone specified.
boolean iamDatabaseAuthenticationEnabled
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
String statusType
This value is currently "read replication."
boolean normal
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
String status
Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
String message
Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
String dbSnapshotIdentifier
Specifies the identifier for the DB snapshot.
String dbInstanceIdentifier
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
LocalDateTime snapshotCreateTime
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
String engine
Specifies the name of the database engine.
Integer allocatedStorage
Specifies the allocated storage size in gigabytes (GB).
String status
Specifies the status of this DB snapshot.
Integer port
Specifies the port that the database engine was listening on at the time of the snapshot.
String availabilityZone
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
String vpcId
Provides the VPC ID associated with the DB snapshot.
LocalDateTime instanceCreateTime
Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
String masterUsername
Provides the master username for the DB snapshot.
String engineVersion
Specifies the version of the database engine.
String licenseModel
License model information for the restored DB instance.
String snapshotType
Provides the type of the DB snapshot.
Integer iops
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
String optionGroupName
Provides the option group name for the DB snapshot.
Integer percentProgress
The percentage of the estimated data that has been transferred.
String sourceRegion
The region that the DB snapshot was created in or copied from.
String sourceDBSnapshotIdentifier
The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
String storageType
Specifies the storage type associated with DB snapshot.
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
boolean encrypted
Specifies whether the DB snapshot is encrypted.
String kmsKeyId
If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.
String dbSnapshotArn
The Amazon Resource Name (ARN) for the DB snapshot.
String timezone
The time zone of the DB snapshot. In most cases, the Timezone element is empty.
Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were
created with a time zone specified.
boolean iamDatabaseAuthenticationEnabled
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
String dBSubnetGroupName
The name of the DB subnet group.
String dBSubnetGroupDescription
Provides the description of the DB subnet group.
String vpcId
Provides the VpcId of the DB subnet group.
String subnetGroupStatus
Provides the status of the DB subnet group.
List<E> subnets
Contains a list of Subnet elements.
String dBSubnetGroupArn
The Amazon Resource Name (ARN) for the DB subnet group.
String domain
The identifier of the Active Directory Domain.
String status
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
String fQDN
The fully qualified domain name of the Active Directory Domain.
String iAMRoleName
The name of the IAM role to be used when making API calls to the Directory Service.
String sourceIdentifier
Provides the identifier for the source of the event.
String sourceType
Specifies the source type for this event.
String message
Provides the text of this event.
List<E> eventCategories
Specifies the category for the event.
LocalDateTime dateValue
Specifies the date and time of the event.
String sourceArn
The Amazon Resource Name (ARN) for the event.
String optionGroupName
The name of the option group that the instance belongs to.
String status
The status of the DB instance's option group membership. Valid values are: in-sync,
pending-apply, pending-removal, pending-maintenance-apply,
pending-maintenance-removal, applying, removing, and failed.
String dBInstanceClass
Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
Integer allocatedStorage
Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
String masterUserPassword
Contains the pending or in-progress change of the master credentials for the DB instance.
Integer port
Specifies the pending port for the DB instance.
Integer backupRetentionPeriod
Specifies the pending number of days for which automated backups are retained.
boolean multiAZ
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
String engineVersion
Indicates the database engine version.
String licenseModel
The license model for the DB instance.
Valid values: license-included | bring-your-own-license |
general-public-license
Integer iops
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
String dBInstanceIdentifier
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
String storageType
Specifies the storage type to be associated with the DB instance.
String cACertificateIdentifier
Specifies the identifier of the CA certificate for the DB instance.
String dBSubnetGroupName
The new DB subnet group for the DB instance.
String reservedDBInstanceId
The unique identifier for the reservation.
String reservedDBInstancesOfferingId
The offering identifier.
String dbInstanceClass
The DB instance class for the reserved DB instance.
LocalDateTime startTime
The time the reservation started.
Integer duration
The duration of the reservation in seconds.
Double fixedPrice
The fixed price charged for this reserved DB instance.
Double usagePrice
The hourly price charged for this reserved DB instance.
String currencyCode
The currency code for the reserved DB instance.
Integer dbInstanceCount
The number of reserved DB instances.
String productDescription
The description of the reserved DB instance.
String offeringType
The offering type of this reserved DB instance.
Boolean multiAZ
Indicates if the reservation applies to Multi-AZ deployments.
String state
The state of the reserved DB instance.
List<E> recurringCharges
The recurring price charged to run this reserved DB instance.
String reservedDBInstanceArn
The Amazon Resource Name (ARN) for the reserved DB instance.
String reservedDBInstancesOfferingId
The offering identifier.
String dBInstanceClass
The DB instance class for the reserved DB instance.
Integer duration
The duration of the offering in seconds.
Double fixedPrice
The fixed price charged for this offering.
Double usagePrice
The hourly price charged for this offering.
String currencyCode
The currency code for the reserved DB instance offering.
String productDescription
The database engine used by the offering.
String offeringType
The offering type.
Boolean multiAZ
Indicates if the offering applies to Multi-AZ deployments.
List<E> recurringCharges
The recurring price charged to run this reserved DB instance.
String key
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
String value
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
Copyright © 2019 MuleSoft, Inc.. All rights reserved.