class Aws::ElasticBeanstalk::Types::CreateEnvironmentMessage

@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",
    }

@!attribute [rw] application_name

The name of the application that is associated with this
environment.
@return [String]

@!attribute [rw] environment_name

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.
@return [String]

@!attribute [rw] group_name

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)][1] for details.

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

@!attribute [rw] description

Your description for this environment.
@return [String]

@!attribute [rw] cname_prefix

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.
@return [String]

@!attribute [rw] tier

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.
@return [Types::EnvironmentTier]

@!attribute [rw] tags

Specifies the tags applied to resources in the environment.
@return [Array<Types::Tag>]

@!attribute [rw] version_label

The name of the application version to deploy.

Default: If not specified, Elastic Beanstalk attempts to deploy the
sample application.
@return [String]

@!attribute [rw] template_name

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>
@return [String]

@!attribute [rw] solution_stack_name

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]: https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html
@return [String]

@!attribute [rw] platform_arn

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

<note markdown="1"> If you specify `PlatformArn`, don't specify `SolutionStackName`.

 </note>

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

@!attribute [rw] option_settings

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.
@return [Array<Types::ConfigurationOptionSetting>]

@!attribute [rw] options_to_remove

A list of custom user-defined configuration options to remove from
the configuration set for this new environment.
@return [Array<Types::OptionSpecification>]

@!attribute [rw] operations_role

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]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreateEnvironmentMessage AWS API Documentation

Constants

SENSITIVE