Stop Db Instance
rds_stop_db_instance | R Documentation |
Stops an Amazon RDS DB instance¶
Description¶
Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora
PostgreSQL. For Aurora clusters, use stop_db_cluster
instead.
Usage¶
Arguments¶
DBInstanceIdentifier
[required] The user-supplied instance identifier.
DBSnapshotIdentifier
The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
Value¶
A list with the following syntax:
list(
DBInstance = list(
DBInstanceIdentifier = "string",
DBInstanceClass = "string",
Engine = "string",
DBInstanceStatus = "string",
AutomaticRestartTime = as.POSIXct(
"2015-01-01"
),
MasterUsername = "string",
DBName = "string",
Endpoint = list(
Address = "string",
Port = 123,
HostedZoneId = "string"
),
AllocatedStorage = 123,
InstanceCreateTime = as.POSIXct(
"2015-01-01"
),
PreferredBackupWindow = "string",
BackupRetentionPeriod = 123,
DBSecurityGroups = list(
list(
DBSecurityGroupName = "string",
Status = "string"
)
),
VpcSecurityGroups = list(
list(
VpcSecurityGroupId = "string",
Status = "string"
)
),
DBParameterGroups = list(
list(
DBParameterGroupName = "string",
ParameterApplyStatus = "string"
)
),
AvailabilityZone = "string",
DBSubnetGroup = list(
DBSubnetGroupName = "string",
DBSubnetGroupDescription = "string",
VpcId = "string",
SubnetGroupStatus = "string",
Subnets = list(
list(
SubnetIdentifier = "string",
SubnetAvailabilityZone = list(
Name = "string"
),
SubnetOutpost = list(
Arn = "string"
),
SubnetStatus = "string"
)
),
DBSubnetGroupArn = "string",
SupportedNetworkTypes = list(
"string"
)
),
PreferredMaintenanceWindow = "string",
PendingModifiedValues = list(
DBInstanceClass = "string",
AllocatedStorage = 123,
MasterUserPassword = "string",
Port = 123,
BackupRetentionPeriod = 123,
MultiAZ = TRUE|FALSE,
EngineVersion = "string",
LicenseModel = "string",
Iops = 123,
DBInstanceIdentifier = "string",
StorageType = "string",
CACertificateIdentifier = "string",
DBSubnetGroupName = "string",
PendingCloudwatchLogsExports = list(
LogTypesToEnable = list(
"string"
),
LogTypesToDisable = list(
"string"
)
),
ProcessorFeatures = list(
list(
Name = "string",
Value = "string"
)
),
IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
AutomationMode = "full"|"all-paused",
ResumeFullAutomationModeTime = as.POSIXct(
"2015-01-01"
),
StorageThroughput = 123,
Engine = "string",
DedicatedLogVolume = TRUE|FALSE,
MultiTenant = TRUE|FALSE
),
LatestRestorableTime = as.POSIXct(
"2015-01-01"
),
MultiAZ = TRUE|FALSE,
EngineVersion = "string",
AutoMinorVersionUpgrade = TRUE|FALSE,
ReadReplicaSourceDBInstanceIdentifier = "string",
ReadReplicaDBInstanceIdentifiers = list(
"string"
),
ReadReplicaDBClusterIdentifiers = list(
"string"
),
ReplicaMode = "open-read-only"|"mounted",
LicenseModel = "string",
Iops = 123,
OptionGroupMemberships = list(
list(
OptionGroupName = "string",
Status = "string"
)
),
CharacterSetName = "string",
NcharCharacterSetName = "string",
SecondaryAvailabilityZone = "string",
PubliclyAccessible = TRUE|FALSE,
StatusInfos = list(
list(
StatusType = "string",
Normal = TRUE|FALSE,
Status = "string",
Message = "string"
)
),
StorageType = "string",
TdeCredentialArn = "string",
DbInstancePort = 123,
DBClusterIdentifier = "string",
StorageEncrypted = TRUE|FALSE,
KmsKeyId = "string",
DbiResourceId = "string",
CACertificateIdentifier = "string",
DomainMemberships = list(
list(
Domain = "string",
Status = "string",
FQDN = "string",
IAMRoleName = "string",
OU = "string",
AuthSecretArn = "string",
DnsIps = list(
"string"
)
)
),
CopyTagsToSnapshot = TRUE|FALSE,
MonitoringInterval = 123,
EnhancedMonitoringResourceArn = "string",
MonitoringRoleArn = "string",
PromotionTier = 123,
DBInstanceArn = "string",
Timezone = "string",
IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
PerformanceInsightsEnabled = TRUE|FALSE,
PerformanceInsightsKMSKeyId = "string",
PerformanceInsightsRetentionPeriod = 123,
EnabledCloudwatchLogsExports = list(
"string"
),
ProcessorFeatures = list(
list(
Name = "string",
Value = "string"
)
),
DeletionProtection = TRUE|FALSE,
AssociatedRoles = list(
list(
RoleArn = "string",
FeatureName = "string",
Status = "string"
)
),
ListenerEndpoint = list(
Address = "string",
Port = 123,
HostedZoneId = "string"
),
MaxAllocatedStorage = 123,
TagList = list(
list(
Key = "string",
Value = "string"
)
),
DBInstanceAutomatedBackupsReplications = list(
list(
DBInstanceAutomatedBackupsArn = "string"
)
),
CustomerOwnedIpEnabled = TRUE|FALSE,
AwsBackupRecoveryPointArn = "string",
ActivityStreamStatus = "stopped"|"starting"|"started"|"stopping",
ActivityStreamKmsKeyId = "string",
ActivityStreamKinesisStreamName = "string",
ActivityStreamMode = "sync"|"async",
ActivityStreamEngineNativeAuditFieldsIncluded = TRUE|FALSE,
AutomationMode = "full"|"all-paused",
ResumeFullAutomationModeTime = as.POSIXct(
"2015-01-01"
),
CustomIamInstanceProfile = "string",
BackupTarget = "string",
NetworkType = "string",
ActivityStreamPolicyStatus = "locked"|"unlocked"|"locking-policy"|"unlocking-policy",
StorageThroughput = 123,
DBSystemId = "string",
MasterUserSecret = list(
SecretArn = "string",
SecretStatus = "string",
KmsKeyId = "string"
),
CertificateDetails = list(
CAIdentifier = "string",
ValidTill = as.POSIXct(
"2015-01-01"
)
),
ReadReplicaSourceDBClusterIdentifier = "string",
PercentProgress = "string",
DedicatedLogVolume = TRUE|FALSE,
IsStorageConfigUpgradeAvailable = TRUE|FALSE,
MultiTenant = TRUE|FALSE,
EngineLifecycleSupport = "string"
)
)