You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb

Overview

Note:

When making an API call, you may pass CreateEnvironmentMessage data as a hash:

{
  application_name: "ApplicationName", # required
  environment_name: "EnvironmentName",
  group_name: "GroupName",
  description: "Description",
  cname_prefix: "DNSCnamePrefix",
  tier: {
    name: "String",
    type: "String",
    version: "String",
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  version_label: "VersionLabel",
  template_name: "ConfigurationTemplateName",
  solution_stack_name: "SolutionStackName",
  platform_arn: "PlatformArn",
  option_settings: [
    {
      resource_name: "ResourceName",
      namespace: "OptionNamespace",
      option_name: "ConfigurationOptionName",
      value: "ConfigurationOptionValue",
    },
  ],
  options_to_remove: [
    {
      resource_name: "ResourceName",
      namespace: "OptionNamespace",
      option_name: "ConfigurationOptionName",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#application_nameString

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.

Returns:

  • (String)


1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1289

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)
  include Aws::Structure
end

#cname_prefixString

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.

Returns:

  • (String)


1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1289

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)
  include Aws::Structure
end

#descriptionString

Describes this environment.

Returns:

  • (String)


1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1289

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)
  include Aws::Structure
end

#environment_nameString

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.

Returns:

  • (String)


1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1289

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)
  include Aws::Structure
end

#group_nameString

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.

Returns:

  • (String)


1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1289

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)
  include Aws::Structure
end

#option_settingsArray<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.



1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1289

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)
  include Aws::Structure
end

#options_to_removeArray<Types::OptionSpecification>

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

Returns:



1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1289

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)
  include Aws::Structure
end

#platform_arnString

The ARN of the platform.

Returns:

  • (String)


1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1289

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)
  include Aws::Structure
end

#solution_stack_nameString

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.

Returns:

  • (String)


1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1289

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)
  include Aws::Structure
end

#tagsArray<Types::Tag>

This specifies the tags applied to resources in the environment.

Returns:



1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1289

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)
  include Aws::Structure
end

#template_nameString

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.

Returns:

  • (String)


1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1289

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)
  include Aws::Structure
end

#tierTypes::EnvironmentTier

This specifies the tier to use for creating this environment.



1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1289

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)
  include Aws::Structure
end

#version_labelString

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.

Returns:

  • (String)


1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1289

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)
  include Aws::Structure
end