« blib/lib/Paws/CodeBuild/EnvironmentPlatform.pm
↑ Summary
blib/lib/Paws/CodeBuild/ExportedEnvironmentVariable.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeBuild::EnvironmentVariable; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1); | ||
| 5 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest']); | ||
| 6 | has Value => (is => 'ro', isa => 'Str', request_name => 'value', traits => ['NameInRequest'], required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::CodeBuild::EnvironmentVariable | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::CodeBuild::EnvironmentVariable object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Name => $value, ..., Value => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::EnvironmentVariable object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Name | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Information about an environment variable for a build project or a | ||
| 39 | build. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> Name => Str | ||
| 45 | |||
| 46 | The name or key of the environment variable. | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Type => Str | ||
| 50 | |||
| 51 | The type of environment variable. Valid values include: | ||
| 52 | |||
| 53 | =over | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | C<PARAMETER_STORE>: An environment variable stored in Systems Manager | ||
| 58 | Parameter Store. To learn how to specify a parameter store environment | ||
| 59 | variable, see env/parameter-store | ||
| 60 | (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store) | ||
| 61 | in the I<CodeBuild User Guide>. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | C<PLAINTEXT>: An environment variable in plain text format. This is the | ||
| 66 | default value. | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | C<SECRETS_MANAGER>: An environment variable stored in Secrets Manager. | ||
| 71 | To learn how to specify a secrets manager environment variable, see | ||
| 72 | env/secrets-manager | ||
| 73 | (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager) | ||
| 74 | in the I<CodeBuild User Guide>. | ||
| 75 | |||
| 76 | =back | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> Value => Str | ||
| 81 | |||
| 82 | The value of the environment variable. | ||
| 83 | |||
| 84 | We strongly discourage the use of C<PLAINTEXT> environment variables to | ||
| 85 | store sensitive values, especially Amazon Web Services secret key IDs | ||
| 86 | and secret access keys. C<PLAINTEXT> environment variables can be | ||
| 87 | displayed in plain text using the CodeBuild console and the AWS Command | ||
| 88 | Line Interface (AWS CLI). For sensitive values, we recommend you use an | ||
| 89 | environment variable of type C<PARAMETER_STORE> or C<SECRETS_MANAGER>. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head1 SEE ALSO | ||
| 94 | |||
| 95 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild> | ||
| 96 | |||
| 97 | =head1 BUGS and CONTRIBUTIONS | ||
| 98 | |||
| 99 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 100 | |||
| 101 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 102 | |||
| 103 | =cut | ||
| 104 |