NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $elasticbeanstalk = Paws->service('ElasticBeanstalk');
 # To update an environment to a new version
 # The following operation updates an environment named "my-env" to version "v2"
 # of the application to which it belongs:
    my $EnvironmentDescription = $elasticbeanstalk->UpdateEnvironment(
      'EnvironmentName' => 'my-env',
      'VersionLabel'    => 'v2'
    );

    # Results:
    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;
    my $VersionLabel      = $EnvironmentDescription->VersionLabel;

# Returns a Paws::ElasticBeanstalk::EnvironmentDescription object. # To configure option settings # The following operation configures several options in the aws:elb:loadbalancer # namespace: my $EnvironmentDescription = $elasticbeanstalk->UpdateEnvironment( 'EnvironmentName' => 'my-env', 'OptionSettings' => [

        {
          'Namespace'  => 'aws:elb:healthcheck',
          'OptionName' => 'Interval',
          'Value'      => 15
        },

        {
          'Namespace'  => 'aws:elb:healthcheck',
          'OptionName' => 'Timeout',
          'Value'      => 8
        },

        {
          'Namespace'  => 'aws:elb:healthcheck',
          'OptionName' => 'HealthyThreshold',
          'Value'      => 2
        },

        {
          'Namespace'  => 'aws:elb:healthcheck',
          'OptionName' => 'UnhealthyThreshold',
          'Value'      => 3
        }
      ]
    );

    # 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;
    my $VersionLabel      = $EnvironmentDescription->VersionLabel;

    # 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/UpdateEnvironment

ATTRIBUTES

ApplicationName => Str

The name of the application with which the environment is associated.

Description => Str

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

EnvironmentId => Str

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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 update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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

GroupName => Str

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) for details.

OptionSettings => ArrayRef[Paws::ElasticBeanstalk::ConfigurationOptionSetting]

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

OptionsToRemove => ArrayRef[Paws::ElasticBeanstalk::OptionSpecification]

A list of custom user-defined configuration options to remove from the configuration set for this environment.

PlatformArn => Str

The ARN of the platform, if used.

SolutionStackName => Str

This specifies the platform version that the environment will run after the environment is updated.

TemplateName => Str

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Tier => Paws::ElasticBeanstalk::EnvironmentTier

This specifies the tier to use to update the environment.

Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

VersionLabel => Str

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateEnvironment 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

cpanm Paws

perl -MCPAN -e shell
install Paws