« blib/lib/Paws/Chime/VoiceConnectorSettings.pm
↑ Summary
blib/lib/Paws/Cloud9/CreateEnvironmentEC2Result.pm »
| 1 | |||
| 2 | package Paws::Cloud9::CreateEnvironmentEC2; | ||
| 3 | use Moose; | ||
| 4 | has AutomaticStopTimeMinutes => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'automaticStopTimeMinutes' ); | ||
| 5 | has ClientRequestToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientRequestToken' ); | ||
| 6 | has ConnectionType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'connectionType' ); | ||
| 7 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description' ); | ||
| 8 | has ImageId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'imageId' ); | ||
| 9 | has InstanceType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'instanceType' , required => 1); | ||
| 10 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name' , required => 1); | ||
| 11 | has OwnerArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'ownerArn' ); | ||
| 12 | has SubnetId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'subnetId' ); | ||
| 13 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Cloud9::Tag]', traits => ['NameInRequest'], request_name => 'tags' ); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateEnvironmentEC2'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Cloud9::CreateEnvironmentEC2Result'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::Cloud9::CreateEnvironmentEC2 - Arguments for method CreateEnvironmentEC2 on L<Paws::Cloud9> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateEnvironmentEC2 on the | ||
| 31 | L<AWS Cloud9|Paws::Cloud9> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateEnvironmentEC2. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEnvironmentEC2. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $cloud9 = Paws->service('Cloud9'); | ||
| 39 | # CreateEnvironmentEC2 | ||
| 40 | my $CreateEnvironmentEC2Result = $cloud9->CreateEnvironmentEC2( | ||
| 41 | 'AutomaticStopTimeMinutes' => 60, | ||
| 42 | 'Description' => 'This is my demonstration environment.', | ||
| 43 | 'InstanceType' => 't2.micro', | ||
| 44 | 'Name' => 'my-demo-environment', | ||
| 45 | 'OwnerArn' => 'arn:aws:iam::123456789012:user/MyDemoUser', | ||
| 46 | 'SubnetId' => 'subnet-1fab8aEX' | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $environmentId = $CreateEnvironmentEC2Result->environmentId; | ||
| 51 | |||
| 52 | # Returns a L<Paws::Cloud9::CreateEnvironmentEC2Result> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloud9/CreateEnvironmentEC2> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 AutomaticStopTimeMinutes => Int | ||
| 61 | |||
| 62 | The number of minutes until the running instance is shut down after the | ||
| 63 | environment has last been used. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 ClientRequestToken => Str | ||
| 68 | |||
| 69 | A unique, case-sensitive string that helps Cloud9 to ensure this | ||
| 70 | operation completes no more than one time. | ||
| 71 | |||
| 72 | For more information, see Client Tokens | ||
| 73 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) | ||
| 74 | in the I<Amazon EC2 API Reference>. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 ConnectionType => Str | ||
| 79 | |||
| 80 | The connection type used for connecting to an Amazon EC2 environment. | ||
| 81 | Valid values are C<CONNECT_SSH> (default) and C<CONNECT_SSM> (connected | ||
| 82 | through Amazon EC2 Systems Manager). | ||
| 83 | |||
| 84 | For more information, see Accessing no-ingress EC2 instances with | ||
| 85 | Amazon EC2 Systems Manager | ||
| 86 | (https://docs.aws.amazon.com/cloud9/latest/user-guide/ec2-ssm.html) in | ||
| 87 | the I<Cloud9 User Guide>. | ||
| 88 | |||
| 89 | Valid values are: C<"CONNECT_SSH">, C<"CONNECT_SSM"> | ||
| 90 | |||
| 91 | =head2 Description => Str | ||
| 92 | |||
| 93 | The description of the environment to create. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 ImageId => Str | ||
| 98 | |||
| 99 | The identifier for the Amazon Machine Image (AMI) that's used to create | ||
| 100 | the EC2 instance. To choose an AMI for the instance, you must specify a | ||
| 101 | valid AMI alias or a valid Amazon EC2 Systems Manager (SSM) path. | ||
| 102 | |||
| 103 | The default AMI is used if the parameter isn't explicitly assigned a | ||
| 104 | value in the request. Because Amazon Linux AMI has ended standard | ||
| 105 | support as of December 31, 2020, we recommend you choose Amazon Linux | ||
| 106 | 2, which includes long term support through 2023. | ||
| 107 | |||
| 108 | B<AMI aliases> | ||
| 109 | |||
| 110 | =over | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | B<Amazon Linux (default): C<amazonlinux-1-x86_64>> | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | Amazon Linux 2: C<amazonlinux-2-x86_64> | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | Ubuntu 18.04: C<ubuntu-18.04-x86_64> | ||
| 123 | |||
| 124 | =back | ||
| 125 | |||
| 126 | B<SSM paths> | ||
| 127 | |||
| 128 | =over | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | B<Amazon Linux (default): | ||
| 133 | C<resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64>> | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | Amazon Linux 2: | ||
| 138 | C<resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64> | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | Ubuntu 18.04: | ||
| 143 | C<resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64> | ||
| 144 | |||
| 145 | =back | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 B<REQUIRED> InstanceType => Str | ||
| 151 | |||
| 152 | The type of instance to connect to the environment (for example, | ||
| 153 | C<t2.micro>). | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 B<REQUIRED> Name => Str | ||
| 158 | |||
| 159 | The name of the environment to create. | ||
| 160 | |||
| 161 | This name is visible to other IAM users in the same Amazon Web Services | ||
| 162 | account. | ||
| 163 | |||
| 164 | |||
| 165 | |||
| 166 | =head2 OwnerArn => Str | ||
| 167 | |||
| 168 | The Amazon Resource Name (ARN) of the environment owner. This ARN can | ||
| 169 | be the ARN of any IAM principal. If this value is not specified, the | ||
| 170 | ARN defaults to this environment's creator. | ||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | =head2 SubnetId => Str | ||
| 175 | |||
| 176 | The ID of the subnet in Amazon VPC that Cloud9 will use to communicate | ||
| 177 | with the Amazon EC2 instance. | ||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | =head2 Tags => ArrayRef[L<Paws::Cloud9::Tag>] | ||
| 182 | |||
| 183 | An array of key-value pairs that will be associated with the new Cloud9 | ||
| 184 | development environment. | ||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | |||
| 189 | =head1 SEE ALSO | ||
| 190 | |||
| 191 | This class forms part of L<Paws>, documenting arguments for method CreateEnvironmentEC2 in L<Paws::Cloud9> | ||
| 192 | |||
| 193 | =head1 BUGS and CONTRIBUTIONS | ||
| 194 | |||
| 195 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 196 | |||
| 197 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 198 | |||
| 199 | =cut | ||
| 200 |