Stop Application

ssmsap_stop_application

R Documentation

Request is an operation to stop an application¶

Description¶

Request is an operation to stop an application.

Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.

Usage¶

ssmsap_stop_application(ApplicationId, StopConnectedEntity,
  IncludeEc2InstanceShutdown)

Arguments¶

ApplicationId

[required] The ID of the application.

StopConnectedEntity

Specify the ConnectedEntityType. Accepted type is DBMS.

If this parameter is included, the connected DBMS (Database Management System) will be stopped.

IncludeEc2InstanceShutdown

Boolean. If included and if set to True, the StopApplication operation will shut down the associated Amazon EC2 instance in addition to the application.

Value¶

A list with the following syntax:

list(
  OperationId = "string"
)

Request syntax¶

svc$stop_application(
  ApplicationId = "string",
  StopConnectedEntity = "DBMS",
  IncludeEc2InstanceShutdown = TRUE|FALSE
)