GetInstanceResult class
Result data returned by getInstance.
Constructors
-
GetInstanceResult({String? address, int? allocatedStorage, bool? autoMinorVersionUpgrade, String? availabilityZone, int? backupRetentionPeriod, String? caCertIdentifier, String? databaseInsightsMode, String? dbClusterIdentifier, String? dbInstanceArn, String? dbInstanceClass, String? dbInstanceIdentifier, int? dbInstancePort, String? dbName, List<
String> ? dbParameterGroups, String? dbSubnetGroup, List<String> ? enabledCloudwatchLogsExports, String? endpoint, String? engine, String? engineVersion, String? hostedZoneId, String? id, int? iops, String? kmsKeyId, String? licenseModel, List<GetInstanceMasterUserSecret> ? masterUserSecrets, String? masterUsername, int? maxAllocatedStorage, int? monitoringInterval, String? monitoringRoleArn, bool? multiAz, String? networkType, List<String> ? optionGroupMemberships, int? port, String? preferredBackupWindow, String? preferredMaintenanceWindow, bool? publiclyAccessible, String? region, String? replicateSourceDb, String? resourceId, bool? storageEncrypted, int? storageThroughput, String? storageType, Map<String, String> ? tags, String? timezone, String? upgradeRolloutOrder, List<String> ? vpcSecurityGroups}) -
Creates a new GetInstanceResult.
addressHostname of the RDS instance. See alsoendpointandport.allocatedStorageAllocated storage size specified in gigabytes.autoMinorVersionUpgradeIndicates that minor version patches are applied automatically.availabilityZoneName of the Availability Zone the DB instance is located in.backupRetentionPeriodSpecifies the number of days for which automatic DB snapshots are retained.caCertIdentifierIdentifier of the CA certificate for the DB instance.databaseInsightsModeThe mode of Database Insights that is enabled for the DB instance.dbClusterIdentifierIf 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.dbInstanceArnARN for the DB instance.dbInstanceClassContains the name of the compute and memory capacity class of the DB instance.dbInstanceIdentifierOptional.dbInstancePortPort that the DB instance listens on.dbNameContains 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.dbParameterGroupsProvides the list of DB parameter groups applied to this DB instance.dbSubnetGroupName of the subnet group associated with the DB instance.enabledCloudwatchLogsExportsList of log types to export to cloudwatch.endpointConnection endpoint inaddress:portformat.engineProvides the name of the database engine to be used for this DB instance.engineVersionDatabase engine version.hostedZoneIdCanonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).idThe provider-assigned unique ID for this managed resource.iopsProvisioned IOPS (I/O operations per second) value.kmsKeyIdThe Amazon Web Services KMS key identifier that is used to encrypt the secret.licenseModelLicense model information for this DB instance.masterUserSecretsProvides the master user secret. Only available whenmanageMasterUserPasswordis set to true. Documented below.masterUsernameContains the master username for the DB instance.maxAllocatedStorageThe upper limit to which Amazon RDS can automatically scale the storage of the DB instance.monitoringIntervalInterval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.monitoringRoleArnARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.multiAzIf the DB instance is a Multi-AZ deployment.networkTypeNetwork type of the DB instance.optionGroupMembershipsProvides the list of option group memberships for this DB instance.portDatabase endpoint port, primarily used by an Aurora DB cluster. For a conventional RDS DB instance, thedbInstancePortis typically the preferred choice.preferredBackupWindowSpecifies the daily time range during which automated backups are created.preferredMaintenanceWindowSpecifies the weekly time range during which system maintenance can occur in UTC.publiclyAccessibleAccessibility options for the DB instance.regionOptional.replicateSourceDbIdentifier of the source DB that this is a replica of.resourceIdRDS Resource ID of this instance.storageEncryptedWhether the DB instance is encrypted.storageThroughputStorage throughput value for the DB instance.storageTypeStorage type associated with DB instance.tagsOptional.timezoneTime zone of the DB instance.upgradeRolloutOrderOrder in which the instances are upgraded (first,second,last). See the AWS documentation for details.vpcSecurityGroupsProvides a list of VPC security group elements that the DB instance belongs to.const -
GetInstanceResult.fromMap(Map<
String, dynamic> map) -
factory
Properties
- address → String?
-
Hostname of the RDS instance. See also
endpointandport.final - allocatedStorage → int?
-
Allocated storage size specified in gigabytes.
final
- autoMinorVersionUpgrade → bool?
-
Indicates that minor version patches are applied automatically.
final
- availabilityZone → String?
-
Name of the Availability Zone the DB instance is located in.
final
- backupRetentionPeriod → int?
-
Specifies the number of days for which automatic DB snapshots are retained.
final
- caCertIdentifier → String?
-
Identifier of the CA certificate for the DB instance.
final
- databaseInsightsMode → String?
-
The mode of Database Insights that is enabled for the DB instance.
final
- dbClusterIdentifier → String?
-
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.
final
- dbInstanceArn → String?
-
ARN for the DB instance.
final
- dbInstanceClass → String?
-
Contains the name of the compute and memory capacity class of the DB instance.
final
- dbInstanceIdentifier → String?
-
final
- dbInstancePort → int?
-
Port that the DB instance listens on.
final
- dbName → String?
-
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.
final
-
dbParameterGroups
→ List<
String> ? -
Provides the list of DB parameter groups applied to this DB instance.
final
- dbSubnetGroup → String?
-
Name of the subnet group associated with the DB instance.
final
-
enabledCloudwatchLogsExports
→ List<
String> ? -
List of log types to export to cloudwatch.
final
- endpoint → String?
-
Connection endpoint in
address:portformat.final - engine → String?
-
Provides the name of the database engine to be used for this DB instance.
final
- engineVersion → String?
-
Database engine version.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hostedZoneId → String?
-
Canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).
final
- id → String?
-
The provider-assigned unique ID for this managed resource.
final
- iops → int?
-
Provisioned IOPS (I/O operations per second) value.
final
- kmsKeyId → String?
-
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
final
- licenseModel → String?
-
License model information for this DB instance.
final
- masterUsername → String?
-
Contains the master username for the DB instance.
final
-
masterUserSecrets
→ List<
GetInstanceMasterUserSecret> ? -
Provides the master user secret. Only available when
manageMasterUserPasswordis set to true. Documented below.final - maxAllocatedStorage → int?
-
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
final
- monitoringInterval → int?
-
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
final
- monitoringRoleArn → String?
-
ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
final
- multiAz → bool?
-
If the DB instance is a Multi-AZ deployment.
final
- networkType → String?
-
Network type of the DB instance.
final
-
optionGroupMemberships
→ List<
String> ? -
Provides the list of option group memberships for this DB instance.
final
- port → int?
-
Database endpoint port, primarily used by an Aurora DB cluster. For a conventional RDS DB instance, the
dbInstancePortis typically the preferred choice.final - preferredBackupWindow → String?
-
Specifies the daily time range during which automated backups are created.
final
- preferredMaintenanceWindow → String?
-
Specifies the weekly time range during which system maintenance can occur in UTC.
final
- publiclyAccessible → bool?
-
Accessibility options for the DB instance.
final
- region → String?
-
final
- replicateSourceDb → String?
-
Identifier of the source DB that this is a replica of.
final
- resourceId → String?
-
RDS Resource ID of this instance.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- storageEncrypted → bool?
-
Whether the DB instance is encrypted.
final
- storageThroughput → int?
-
Storage throughput value for the DB instance.
final
- storageType → String?
-
Storage type associated with DB instance.
final
-
final
- timezone → String?
-
Time zone of the DB instance.
final
- upgradeRolloutOrder → String?
-
Order in which the instances are upgraded (
first,second,last). See the AWS documentation for details.final -
vpcSecurityGroups
→ List<
String> ? -
Provides a list of VPC security group elements that the DB instance belongs to.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited