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.

CreateEnvironmentInput

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

type CreateEnvironmentInput struct { ApplicationName *string `min:"1" type:"string" required:"true"` CNAMEPrefix *string `min:"4" type:"string"` Description *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"` Tags []*Tag `type:"list"` TemplateName *string `min:"1" type:"string"` Tier *EnvironmentTier `type:"structure"` VersionLabel *string `min:"1" type:"string"` }

ApplicationName

Type: *string

The name of the application that contains the version to be deployed.

If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

ApplicationName is a required field

CNAMEPrefix

Type: *string

If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

Description

Type: *string

Describes this environment.

EnvironmentName

Type: *string

A unique name for the deployment environment. Used in the application URL.

Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

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 parameter. 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.

SolutionStackName

Type: *string

This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.

For a list of current solution stacks, see Elastic Beanstalk Supported Platforms (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html).

Tags

Describes a tag applied to a resource in an environment.

TemplateName

Type: *string

The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Tier

Describes the properties of an environment tier

VersionLabel

Type: *string

The name of the application version to deploy.

If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

Method

GoString

func (s CreateEnvironmentInput) GoString() string

GoString returns the string representation

SetApplicationName

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

SetApplicationName sets the ApplicationName field's value.

SetCNAMEPrefix

func (s *CreateEnvironmentInput) SetCNAMEPrefix(v string) *CreateEnvironmentInput

SetCNAMEPrefix sets the CNAMEPrefix field's value.

SetDescription

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

SetDescription sets the Description field's value.

SetEnvironmentName

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

SetEnvironmentName sets the EnvironmentName field's value.

SetGroupName

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

SetGroupName sets the GroupName field's value.

SetOptionSettings

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

SetOptionSettings sets the OptionSettings field's value.

SetOptionsToRemove

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

SetOptionsToRemove sets the OptionsToRemove field's value.

SetPlatformArn

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

SetPlatformArn sets the PlatformArn field's value.

SetSolutionStackName

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

SetSolutionStackName sets the SolutionStackName field's value.

SetTags

func (s *CreateEnvironmentInput) SetTags(v []*Tag) *CreateEnvironmentInput

SetTags sets the Tags field's value.

SetTemplateName

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

SetTemplateName sets the TemplateName field's value.

SetTier

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

SetTier sets the Tier field's value.

SetVersionLabel

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

SetVersionLabel sets the VersionLabel field's value.

String

func (s CreateEnvironmentInput) String() string

String returns the string representation

Validate

func (s *CreateEnvironmentInput) Validate() error

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

On this page: