AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

TerminateEnvironmentInput

import "github.com/aws/aws-sdk-go/service/elasticbeanstalk"

type TerminateEnvironmentInput struct { EnvironmentId *string `type:"string"` EnvironmentName *string `min:"4" type:"string"` ForceTerminate *bool `type:"boolean"` TerminateResources *bool `type:"boolean"` }

Request to terminate an environment.

EnvironmentId

Type: *string

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

Type: *string

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.

ForceTerminate

Type: *bool

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

TerminateResources

Type: *bool

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. (https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/)

Default: true

Valid Values: true | false

Method

GoString

func (s TerminateEnvironmentInput) GoString() string

GoString returns the string representation

SetEnvironmentId

func (s *TerminateEnvironmentInput) SetEnvironmentId(v string) *TerminateEnvironmentInput

SetEnvironmentId sets the EnvironmentId field's value.

SetEnvironmentName

func (s *TerminateEnvironmentInput) SetEnvironmentName(v string) *TerminateEnvironmentInput

SetEnvironmentName sets the EnvironmentName field's value.

SetForceTerminate

func (s *TerminateEnvironmentInput) SetForceTerminate(v bool) *TerminateEnvironmentInput

SetForceTerminate sets the ForceTerminate field's value.

SetTerminateResources

func (s *TerminateEnvironmentInput) SetTerminateResources(v bool) *TerminateEnvironmentInput

SetTerminateResources sets the TerminateResources field's value.

String

func (s TerminateEnvironmentInput) String() string

String returns the string representation

Validate

func (s *TerminateEnvironmentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: