/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ElasticBeanstalk::TerminateEnvironment

NAME

Paws::ElasticBeanstalk::TerminateEnvironment - Arguments for method TerminateEnvironment on Paws::ElasticBeanstalk

DESCRIPTION

This class represents the parameters used for calling the method TerminateEnvironment on the AWS Elastic Beanstalk service. Use the attributes of this class as arguments to method TerminateEnvironment.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TerminateEnvironment.

SYNOPSIS

my $elasticbeanstalk = Paws->service('ElasticBeanstalk');
# To terminate an environment
# The following operation terminates an Elastic Beanstalk environment named
# my-env:
my $EnvironmentDescription =
  $elasticbeanstalk->TerminateEnvironment( 'EnvironmentName' => 'my-env' );

# Results:
my $AbortableOperationInProgress =
  $EnvironmentDescription->AbortableOperationInProgress;
my $ApplicationName   = $EnvironmentDescription->ApplicationName;
my $CNAME             = $EnvironmentDescription->CNAME;
my $DateCreated       = $EnvironmentDescription->DateCreated;
my $DateUpdated       = $EnvironmentDescription->DateUpdated;
my $EndpointURL       = $EnvironmentDescription->EndpointURL;
my $EnvironmentId     = $EnvironmentDescription->EnvironmentId;
my $EnvironmentName   = $EnvironmentDescription->EnvironmentName;
my $Health            = $EnvironmentDescription->Health;
my $SolutionStackName = $EnvironmentDescription->SolutionStackName;
my $Status            = $EnvironmentDescription->Status;
my $Tier              = $EnvironmentDescription->Tier;

# Returns a L<Paws::ElasticBeanstalk::EnvironmentDescription> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk/TerminateEnvironment

ATTRIBUTES

EnvironmentId => Str

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 => Str

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 => Bool

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

TerminateResources => 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

SEE ALSO

This class forms part of Paws, documenting arguments for method TerminateEnvironment in Paws::ElasticBeanstalk

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues