Terminate Environment

elasticbeanstalk_terminate_environment

R Documentation

Terminates the specified environment

Description

Terminates the specified environment.

Usage

elasticbeanstalk_terminate_environment(EnvironmentId, EnvironmentName,
  TerminateResources, ForceTerminate)

Arguments

EnvironmentId

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

EnvironmentName

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

TerminateResources

Indicates whether the associated AWS resources should shut down when the environment is terminated:

• true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.

• false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

For more information, see the AWS Elastic Beanstalk User Guide.

Default: true

Valid Values: true | false

ForceTerminate

Terminates the target environment even if another environment in the same group is dependent on it.

Value

A list with the following syntax:

list(
  EnvironmentName = "string",
  EnvironmentId = "string",
  ApplicationName = "string",
  VersionLabel = "string",
  SolutionStackName = "string",
  PlatformArn = "string",
  TemplateName = "string",
  Description = "string",
  EndpointURL = "string",
  CNAME = "string",
  DateCreated = as.POSIXct(
    "2015-01-01"
  ),
  DateUpdated = as.POSIXct(
    "2015-01-01"
  ),
  Status = "Aborting"|"Launching"|"Updating"|"LinkingFrom"|"LinkingTo"|"Ready"|"Terminating"|"Terminated",
  AbortableOperationInProgress = TRUE|FALSE,
  Health = "Green"|"Yellow"|"Red"|"Grey",
  HealthStatus = "NoData"|"Unknown"|"Pending"|"Ok"|"Info"|"Warning"|"Degraded"|"Severe"|"Suspended",
  Resources = list(
    LoadBalancer = list(
      LoadBalancerName = "string",
      Domain = "string",
      Listeners = list(
        list(
          Protocol = "string",
          Port = 123
        )
      )
    )
  ),
  Tier = list(
    Name = "string",
    Type = "string",
    Version = "string"
  ),
  EnvironmentLinks = list(
    list(
      LinkName = "string",
      EnvironmentName = "string"
    )
  ),
  EnvironmentArn = "string",
  OperationsRole = "string"
)

Request syntax

svc$terminate_environment(
  EnvironmentId = "string",
  EnvironmentName = "string",
  TerminateResources = TRUE|FALSE,
  ForceTerminate = TRUE|FALSE
)

Examples

## Not run: 
# The following operation terminates an Elastic Beanstalk environment
# named my-env:
svc$terminate_environment(
  EnvironmentName = "my-env"
)

## End(Not run)