« blib/lib/Paws/ElasticBeanstalk/CreateConfigurationTemplate.pm
↑ Summary
blib/lib/Paws/ElasticBeanstalk/CreateStorageLocation.pm »
| 1 | |||
| 2 | package Paws::ElasticBeanstalk::CreateEnvironment; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has ApplicationName => (is => 'ro', isa => 'Str', required => 1); | |
| 5 | 1 | has CNAMEPrefix => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has Description => (is => 'ro', isa => 'Str'); | |
| 7 | 1 | has EnvironmentName => (is => 'ro', isa => 'Str'); | |
| 8 | 1 | has GroupName => (is => 'ro', isa => 'Str'); | |
| 9 | 1 | has OperationsRole => (is => 'ro', isa => 'Str'); | |
| 10 | 1 | has OptionSettings => (is => 'ro', isa => 'ArrayRef[Paws::ElasticBeanstalk::ConfigurationOptionSetting]'); | |
| 11 | 1 | has OptionsToRemove => (is => 'ro', isa => 'ArrayRef[Paws::ElasticBeanstalk::OptionSpecification]'); | |
| 12 | 1 | has PlatformArn => (is => 'ro', isa => 'Str'); | |
| 13 | 1 | has SolutionStackName => (is => 'ro', isa => 'Str'); | |
| 14 | 1 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ElasticBeanstalk::Tag]'); | |
| 15 | 1 | has TemplateName => (is => 'ro', isa => 'Str'); | |
| 16 | 1 | has Tier => (is => 'ro', isa => 'Paws::ElasticBeanstalk::EnvironmentTier'); | |
| 17 | 1 | has VersionLabel => (is => 'ro', isa => 'Str'); | |
| 18 | |||
| 19 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 20 | |||
| 21 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateEnvironment'); | |
| 22 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElasticBeanstalk::EnvironmentDescription'); | |
| 23 | 1 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateEnvironmentResult'); | |
| 24 | 1 | 1; | |
| 25 | |||
| 26 | ### main pod documentation begin ### | ||
| 27 | |||
| 28 | =head1 NAME | ||
| 29 | |||
| 30 | Paws::ElasticBeanstalk::CreateEnvironment - Arguments for method CreateEnvironment on L<Paws::ElasticBeanstalk> | ||
| 31 | |||
| 32 | =head1 DESCRIPTION | ||
| 33 | |||
| 34 | This class represents the parameters used for calling the method CreateEnvironment on the | ||
| 35 | L<AWS Elastic Beanstalk|Paws::ElasticBeanstalk> service. Use the attributes of this class | ||
| 36 | as arguments to method CreateEnvironment. | ||
| 37 | |||
| 38 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEnvironment. | ||
| 39 | |||
| 40 | =head1 SYNOPSIS | ||
| 41 | |||
| 42 | my $elasticbeanstalk = Paws->service('ElasticBeanstalk'); | ||
| 43 | # To create a new environment for an application | ||
| 44 | # The following operation creates a new environment for version v1 of a java | ||
| 45 | # application named my-app: | ||
| 46 | my $EnvironmentDescription = $elasticbeanstalk->CreateEnvironment( | ||
| 47 | 'ApplicationName' => 'my-app', | ||
| 48 | 'CNAMEPrefix' => 'my-app', | ||
| 49 | 'EnvironmentName' => 'my-env', | ||
| 50 | 'SolutionStackName' => | ||
| 51 | '64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8', | ||
| 52 | 'VersionLabel' => 'v1' | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $ApplicationName = $EnvironmentDescription->ApplicationName; | ||
| 57 | my $CNAME = $EnvironmentDescription->CNAME; | ||
| 58 | my $DateCreated = $EnvironmentDescription->DateCreated; | ||
| 59 | my $DateUpdated = $EnvironmentDescription->DateUpdated; | ||
| 60 | my $EnvironmentId = $EnvironmentDescription->EnvironmentId; | ||
| 61 | my $EnvironmentName = $EnvironmentDescription->EnvironmentName; | ||
| 62 | my $Health = $EnvironmentDescription->Health; | ||
| 63 | my $SolutionStackName = $EnvironmentDescription->SolutionStackName; | ||
| 64 | my $Status = $EnvironmentDescription->Status; | ||
| 65 | my $Tier = $EnvironmentDescription->Tier; | ||
| 66 | my $VersionLabel = $EnvironmentDescription->VersionLabel; | ||
| 67 | |||
| 68 | # Returns a L<Paws::ElasticBeanstalk::EnvironmentDescription> object. | ||
| 69 | |||
| 70 | 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. | ||
| 71 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk/CreateEnvironment> | ||
| 72 | |||
| 73 | =head1 ATTRIBUTES | ||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> ApplicationName => Str | ||
| 77 | |||
| 78 | The name of the application that is associated with this environment. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 CNAMEPrefix => Str | ||
| 83 | |||
| 84 | If specified, the environment attempts to use this value as the prefix | ||
| 85 | for the CNAME in your Elastic Beanstalk environment URL. If not | ||
| 86 | specified, the CNAME is generated automatically by appending a random | ||
| 87 | alphanumeric string to the environment name. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 Description => Str | ||
| 92 | |||
| 93 | Your description for this environment. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 EnvironmentName => Str | ||
| 98 | |||
| 99 | A unique name for the environment. | ||
| 100 | |||
| 101 | Constraint: Must be from 4 to 40 characters in length. The name can | ||
| 102 | contain only letters, numbers, and hyphens. It can't start or end with | ||
| 103 | a hyphen. This name must be unique within a region in your account. If | ||
| 104 | the specified name already exists in the region, Elastic Beanstalk | ||
| 105 | returns an C<InvalidParameterValue> error. | ||
| 106 | |||
| 107 | If you don't specify the C<CNAMEPrefix> parameter, the environment name | ||
| 108 | becomes part of the CNAME, and therefore part of the visible URL for | ||
| 109 | your application. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 GroupName => Str | ||
| 114 | |||
| 115 | The name of the group to which the target environment belongs. Specify | ||
| 116 | a group name only if the environment's name is specified in an | ||
| 117 | environment manifest and not with the environment name parameter. See | ||
| 118 | Environment Manifest (env.yaml) | ||
| 119 | (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) | ||
| 120 | for details. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 OperationsRole => Str | ||
| 125 | |||
| 126 | The Amazon Resource Name (ARN) of an existing IAM role to be used as | ||
| 127 | the environment's operations role. If specified, Elastic Beanstalk uses | ||
| 128 | the operations role for permissions to downstream services during this | ||
| 129 | call and during subsequent calls acting on this environment. To specify | ||
| 130 | an operations role, you must have the C<iam:PassRole> permission for | ||
| 131 | the role. For more information, see Operations roles | ||
| 132 | (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) | ||
| 133 | in the I<AWS Elastic Beanstalk Developer Guide>. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 OptionSettings => ArrayRef[L<Paws::ElasticBeanstalk::ConfigurationOptionSetting>] | ||
| 138 | |||
| 139 | If specified, AWS Elastic Beanstalk sets the specified configuration | ||
| 140 | options to the requested value in the configuration set for the new | ||
| 141 | environment. These override the values obtained from the solution stack | ||
| 142 | or the configuration template. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head2 OptionsToRemove => ArrayRef[L<Paws::ElasticBeanstalk::OptionSpecification>] | ||
| 147 | |||
| 148 | A list of custom user-defined configuration options to remove from the | ||
| 149 | configuration set for this new environment. | ||
| 150 | |||
| 151 | |||
| 152 | |||
| 153 | =head2 PlatformArn => Str | ||
| 154 | |||
| 155 | The Amazon Resource Name (ARN) of the custom platform to use with the | ||
| 156 | environment. For more information, see Custom Platforms | ||
| 157 | (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) | ||
| 158 | in the I<AWS Elastic Beanstalk Developer Guide>. | ||
| 159 | |||
| 160 | If you specify C<PlatformArn>, don't specify C<SolutionStackName>. | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head2 SolutionStackName => Str | ||
| 165 | |||
| 166 | The name of an Elastic Beanstalk solution stack (platform version) to | ||
| 167 | use with the environment. If specified, Elastic Beanstalk sets the | ||
| 168 | configuration values to the default values associated with the | ||
| 169 | specified solution stack. For a list of current solution stacks, see | ||
| 170 | Elastic Beanstalk Supported Platforms | ||
| 171 | (https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html) | ||
| 172 | in the I<AWS Elastic Beanstalk Platforms> guide. | ||
| 173 | |||
| 174 | If you specify C<SolutionStackName>, don't specify C<PlatformArn> or | ||
| 175 | C<TemplateName>. | ||
| 176 | |||
| 177 | |||
| 178 | |||
| 179 | =head2 Tags => ArrayRef[L<Paws::ElasticBeanstalk::Tag>] | ||
| 180 | |||
| 181 | Specifies the tags applied to resources in the environment. | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head2 TemplateName => Str | ||
| 186 | |||
| 187 | The name of the Elastic Beanstalk configuration template to use with | ||
| 188 | the environment. | ||
| 189 | |||
| 190 | If you specify C<TemplateName>, then don't specify | ||
| 191 | C<SolutionStackName>. | ||
| 192 | |||
| 193 | |||
| 194 | |||
| 195 | =head2 Tier => L<Paws::ElasticBeanstalk::EnvironmentTier> | ||
| 196 | |||
| 197 | Specifies the tier to use in creating this environment. The environment | ||
| 198 | tier that you choose determines whether Elastic Beanstalk provisions | ||
| 199 | resources to support a web application that handles HTTP(S) requests or | ||
| 200 | a web application that handles background-processing tasks. | ||
| 201 | |||
| 202 | |||
| 203 | |||
| 204 | =head2 VersionLabel => Str | ||
| 205 | |||
| 206 | The name of the application version to deploy. | ||
| 207 | |||
| 208 | Default: If not specified, Elastic Beanstalk attempts to deploy the | ||
| 209 | sample application. | ||
| 210 | |||
| 211 | |||
| 212 | |||
| 213 | |||
| 214 | =head1 SEE ALSO | ||
| 215 | |||
| 216 | This class forms part of L<Paws>, documenting arguments for method CreateEnvironment in L<Paws::ElasticBeanstalk> | ||
| 217 | |||
| 218 | =head1 BUGS and CONTRIBUTIONS | ||
| 219 | |||
| 220 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 221 | |||
| 222 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 223 | |||
| 224 | =cut | ||
| 225 | |||