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",
    },
  ],
  operations_role: "OperationsRole",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_nameString

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

Returns:

  • (String)


1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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_prefixString

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)


1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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

#descriptionString

Your description for this environment.

Returns:

  • (String)


1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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_nameString

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)


1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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_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)


1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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_roleString

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 in the AWS Elastic Beanstalk Developer Guide.

Returns:

  • (String)


1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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_removeArray<Types::OptionSpecification>

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

Returns:



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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_arnString

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.

If you specify PlatformArn, don't specify SolutionStackName.

Returns:

  • (String)


1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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_nameString

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 in the AWS Elastic Beanstalk Platforms guide.

If you specify SolutionStackName, don't specify PlatformArn or TemplateName.

Returns:

  • (String)


1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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

#tagsArray<Types::Tag>

Specifies the tags applied to resources in the environment.

Returns:



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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_nameString

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

If you specify TemplateName, then don't specify SolutionStackName.

Returns:

  • (String)


1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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

#tierTypes::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.



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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_labelString

The name of the application version to deploy.

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

Returns:

  • (String)


1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1517

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