NAME

Paws::ElasticBeanstalk::CreateEnvironment - Arguments for method CreateEnvironment on Paws::ElasticBeanstalk

DESCRIPTION

This class represents the parameters used for calling the method CreateEnvironment on the AWS Elastic Beanstalk service. Use the attributes of this class as arguments to method CreateEnvironment.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEnvironment.

SYNOPSIS

    my $elasticbeanstalk = Paws->service('ElasticBeanstalk');
    # To create a new environment for an application
    # The following operation creates a new environment for version v1 of a java
    # application named my-app:
    my $EnvironmentDescription = $elasticbeanstalk->CreateEnvironment(
      'ApplicationName'   => 'my-app',
      'CNAMEPrefix'       => 'my-app',
      'EnvironmentName'   => 'my-env',
      'SolutionStackName' =>
        '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8',
      'VersionLabel' => 'v1'
    );
    # Results:
    my $ApplicationName   = $EnvironmentDescription->ApplicationName;
    my $CNAME             = $EnvironmentDescription->CNAME;
    my $DateCreated       = $EnvironmentDescription->DateCreated;
    my $DateUpdated       = $EnvironmentDescription->DateUpdated;
    my $EnvironmentId     = $EnvironmentDescription->EnvironmentId;
    my $EnvironmentName   = $EnvironmentDescription->EnvironmentName;
    my $Health            = $EnvironmentDescription->Health;
    my $SolutionStackName = $EnvironmentDescription->SolutionStackName;
    my $Status            = $EnvironmentDescription->Status;
    my $Tier              = $EnvironmentDescription->Tier;
    my $VersionLabel      = $EnvironmentDescription->VersionLabel;
    # Returns a L<Paws::ElasticBeanstalk::EnvironmentDescription> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk/CreateEnvironment>

ATTRIBUTES

REQUIRED ApplicationName => Str

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

CNAMEPrefix => Str

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.

Description => Str

Your description for this environment.

EnvironmentName => Str

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.

GroupName => Str

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.

OperationsRole => Str

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 (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) in the AWS Elastic Beanstalk Developer Guide.

OptionSettings => ArrayRef[Paws::ElasticBeanstalk::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.

OptionsToRemove => ArrayRef[Paws::ElasticBeanstalk::OptionSpecification]

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

PlatformArn => Str

The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide.

If you specify "PlatformArn", don't specify "SolutionStackName".

SolutionStackName => Str

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 (https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html) in the AWS Elastic Beanstalk Platforms guide.

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

Tags => ArrayRef[Paws::ElasticBeanstalk::Tag]

Specifies the tags applied to resources in the environment.

TemplateName => Str

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

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

Tier => Paws::ElasticBeanstalk::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.

VersionLabel => Str

The name of the application version to deploy.

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

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>