« blib/lib/Paws/Cloud9/DescribeEnvironmentsResult.pm
↑ Summary
blib/lib/Paws/Cloud9/EnvironmentLifecycle.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Cloud9::Environment; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest'], required => 1); | ||
| 5 | has ConnectionType => (is => 'ro', isa => 'Str', request_name => 'connectionType', traits => ['NameInRequest']); | ||
| 6 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']); | ||
| 7 | has Id => (is => 'ro', isa => 'Str', request_name => 'id', traits => ['NameInRequest']); | ||
| 8 | has Lifecycle => (is => 'ro', isa => 'Paws::Cloud9::EnvironmentLifecycle', request_name => 'lifecycle', traits => ['NameInRequest']); | ||
| 9 | has ManagedCredentialsStatus => (is => 'ro', isa => 'Str', request_name => 'managedCredentialsStatus', traits => ['NameInRequest']); | ||
| 10 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 11 | has OwnerArn => (is => 'ro', isa => 'Str', request_name => 'ownerArn', traits => ['NameInRequest'], required => 1); | ||
| 12 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Cloud9::Environment | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::Cloud9::Environment object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { Arn => $value, ..., Type => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::Cloud9::Environment object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->Arn | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Information about an Cloud9 development environment. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> Arn => Str | ||
| 50 | |||
| 51 | The Amazon Resource Name (ARN) of the environment. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 ConnectionType => Str | ||
| 55 | |||
| 56 | The connection type used for connecting to an Amazon EC2 environment. | ||
| 57 | C<CONNECT_SSH> is selected by default. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Description => Str | ||
| 61 | |||
| 62 | The description for the environment. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 Id => Str | ||
| 66 | |||
| 67 | The ID of the environment. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 Lifecycle => L<Paws::Cloud9::EnvironmentLifecycle> | ||
| 71 | |||
| 72 | The state of the environment in its creation or deletion lifecycle. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 ManagedCredentialsStatus => Str | ||
| 76 | |||
| 77 | Describes the status of Amazon Web Services managed temporary | ||
| 78 | credentials for the Cloud9 environment. Available values are: | ||
| 79 | |||
| 80 | =over | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<ENABLED_ON_CREATE> | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | C<ENABLED_BY_OWNER> | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<DISABLED_BY_DEFAULT> | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | C<DISABLED_BY_OWNER> | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<DISABLED_BY_COLLABORATOR> | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | C<PENDING_REMOVAL_BY_COLLABORATOR> | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | C<PENDING_REMOVAL_BY_OWNER> | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<FAILED_REMOVAL_BY_COLLABORATOR> | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | C<ENABLED_BY_OWNER> | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | C<DISABLED_BY_DEFAULT> | ||
| 121 | |||
| 122 | =back | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 Name => Str | ||
| 127 | |||
| 128 | The name of the environment. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 B<REQUIRED> OwnerArn => Str | ||
| 132 | |||
| 133 | The Amazon Resource Name (ARN) of the environment owner. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 B<REQUIRED> Type => Str | ||
| 137 | |||
| 138 | The type of environment. Valid values include the following: | ||
| 139 | |||
| 140 | =over | ||
| 141 | |||
| 142 | =item * | ||
| 143 | |||
| 144 | C<ec2>: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects | ||
| 145 | to the environment. | ||
| 146 | |||
| 147 | =item * | ||
| 148 | |||
| 149 | C<ssh>: Your own server connects to the environment. | ||
| 150 | |||
| 151 | =back | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head1 SEE ALSO | ||
| 157 | |||
| 158 | This class forms part of L<Paws>, describing an object used in L<Paws::Cloud9> | ||
| 159 | |||
| 160 | =head1 BUGS and CONTRIBUTIONS | ||
| 161 | |||
| 162 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 163 | |||
| 164 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 165 | |||
| 166 | =cut | ||
| 167 |