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.

UpdateEnvironmentInput

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

type UpdateEnvironmentInput struct { ApplicationName *string `min:"1" type:"string"` Description *string `type:"string"` EnvironmentId *string `type:"string"` EnvironmentName *string `min:"4" type:"string"` GroupName *string `min:"1" type:"string"` OptionSettings []*ConfigurationOptionSetting `type:"list"` OptionsToRemove []*OptionSpecification `type:"list"` PlatformArn *string `type:"string"` SolutionStackName *string `type:"string"` TemplateName *string `min:"1" type:"string"` Tier *EnvironmentTier `type:"structure"` VersionLabel *string `min:"1" type:"string"` }

Request to update an environment.

ApplicationName

Type: *string

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

Description

Type: *string

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

EnvironmentId

Type: *string

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

Type: *string

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

Type: *string

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

A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide.

OptionsToRemove

A specification identifying an individual configuration option.

PlatformArn

Type: *string

The ARN of the platform, if used.

SolutionStackName

Type: *string

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

TemplateName

Type: *string

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

Describes the properties of an environment tier

VersionLabel

Type: *string

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.

Method

GoString

func (s UpdateEnvironmentInput) GoString() string

GoString returns the string representation

SetApplicationName

func (s *UpdateEnvironmentInput) SetApplicationName(v string) *UpdateEnvironmentInput

SetApplicationName sets the ApplicationName field's value.

SetDescription

func (s *UpdateEnvironmentInput) SetDescription(v string) *UpdateEnvironmentInput

SetDescription sets the Description field's value.

SetEnvironmentId

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

SetEnvironmentId sets the EnvironmentId field's value.

SetEnvironmentName

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

SetEnvironmentName sets the EnvironmentName field's value.

SetGroupName

func (s *UpdateEnvironmentInput) SetGroupName(v string) *UpdateEnvironmentInput

SetGroupName sets the GroupName field's value.

SetOptionSettings

func (s *UpdateEnvironmentInput) SetOptionSettings(v []*ConfigurationOptionSetting) *UpdateEnvironmentInput

SetOptionSettings sets the OptionSettings field's value.

SetOptionsToRemove

func (s *UpdateEnvironmentInput) SetOptionsToRemove(v []*OptionSpecification) *UpdateEnvironmentInput

SetOptionsToRemove sets the OptionsToRemove field's value.

SetPlatformArn

func (s *UpdateEnvironmentInput) SetPlatformArn(v string) *UpdateEnvironmentInput

SetPlatformArn sets the PlatformArn field's value.

SetSolutionStackName

func (s *UpdateEnvironmentInput) SetSolutionStackName(v string) *UpdateEnvironmentInput

SetSolutionStackName sets the SolutionStackName field's value.

SetTemplateName

func (s *UpdateEnvironmentInput) SetTemplateName(v string) *UpdateEnvironmentInput

SetTemplateName sets the TemplateName field's value.

SetTier

func (s *UpdateEnvironmentInput) SetTier(v *EnvironmentTier) *UpdateEnvironmentInput

SetTier sets the Tier field's value.

SetVersionLabel

func (s *UpdateEnvironmentInput) SetVersionLabel(v string) *UpdateEnvironmentInput

SetVersionLabel sets the VersionLabel field's value.

String

func (s UpdateEnvironmentInput) String() string

String returns the string representation

Validate

func (s *UpdateEnvironmentInput) Validate() error

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

On this page: