Class: Aws::ElasticBeanstalk::Types::CreateEnvironmentMessage

Inherits:

Struct

• Object
• Struct
• Aws::ElasticBeanstalk::Types::CreateEnvironmentMessage

Includes:

Structure

Defined in:

lib/aws-sdk-elasticbeanstalk/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_name ⇒ String

  The name of the application that is associated with this environment.

• #cname_prefix ⇒ String

  If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL.

• #description ⇒ String

  Your description for this environment.

• #environment_name ⇒ String

  A unique name for the environment.

• #group_name ⇒ String

  The name of the group to which the target environment belongs.

• #operations_role ⇒ String

  The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment’s operations role.

• #option_settings ⇒ Array<Types::ConfigurationOptionSetting>

  If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment.

• #options_to_remove ⇒ Array<Types::OptionSpecification>

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

• #platform_arn ⇒ String

  The Amazon Resource Name (ARN) of the custom platform to use with the environment.

• #solution_stack_name ⇒ String

  The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.

• #tags ⇒ Array<Types::Tag>

  Specifies the tags applied to resources in the environment.

• #template_name ⇒ String

  The name of the Elastic Beanstalk configuration template to use with the environment.

• #tier ⇒ Types::EnvironmentTier

  Specifies the tier to use in creating this environment.

• #version_label ⇒ String

  The name of the application version to deploy.

Instance Attribute Details

#application_name ⇒ String

The name of the application that is associated with this environment.

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#cname_prefix ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Your description for this environment.

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#environment_name ⇒ String

A unique name for the environment.

Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can’t 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, Elastic Beanstalk returns an ‘InvalidParameterValue` error.

If you don’t specify the ‘CNAMEPrefix` parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#group_name ⇒ 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)] for details.

[1]: docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#operations_role ⇒ String

The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment’s operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the ‘iam:PassRole` permission for the role. For more information, see

Operations roles][1

in the *AWS Elastic Beanstalk Developer

Guide*.

[1]: docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#option_settings ⇒ Array<Types::ConfigurationOptionSetting>

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

Returns:

• (Array<Types::ConfigurationOptionSetting>)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#options_to_remove ⇒ Array<Types::OptionSpecification>

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

Returns:

• (Array<Types::OptionSpecification>)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#platform_arn ⇒ String

The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see [Custom Platforms] in the *AWS Elastic Beanstalk Developer Guide*.

<note markdown=“1”> If you specify ‘PlatformArn`, don’t specify ‘SolutionStackName`.

</note>

[1]: docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#solution_stack_name ⇒ String

The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified, 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][1

in the *AWS Elastic

Beanstalk Platforms* guide.

<note markdown=“1”> If you specify ‘SolutionStackName`, don’t specify ‘PlatformArn` or `TemplateName`.

</note>

[1]: docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Specifies the tags applied to resources in the environment.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#template_name ⇒ String

The name of the Elastic Beanstalk configuration template to use with the environment.

<note markdown=“1”> If you specify ‘TemplateName`, then don’t specify ‘SolutionStackName`.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#tier ⇒ Types::EnvironmentTier

Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.

Returns:

• (Types::EnvironmentTier)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end

#version_label ⇒ String

The name of the application version to deploy.

Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 1286

class CreateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_name,
  :group_name,
  :description,
  :cname_prefix,
  :tier,
  :tags,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove,
  :operations_role)
  SENSITIVE = []
  include Aws::Structure
end