File Coverage

blib/lib/Paws/OpsWorks/Source.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::OpsWorks::Source;
2 1     1   542 use Moose;
  1         16  
  1         12  
3             has Password => (is => 'ro', isa => 'Str');
4             has Revision => (is => 'ro', isa => 'Str');
5             has SshKey => (is => 'ro', isa => 'Str');
6             has Type => (is => 'ro', isa => 'Str');
7             has Url => (is => 'ro', isa => 'Str');
8             has Username => (is => 'ro', isa => 'Str');
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::OpsWorks::Source
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::OpsWorks::Source object:
27              
28             $service_obj->Method(Att1 => { Password => $value, ..., Username => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::OpsWorks::Source object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->Password
36              
37             =head1 DESCRIPTION
38              
39             Contains the information required to retrieve an app or cookbook from a
40             repository. For more information, see Creating Apps or Custom Recipes
41             and Cookbooks.
42              
43             =head1 ATTRIBUTES
44              
45              
46             =head2 Password => Str
47              
48             When included in a request, the parameter depends on the repository
49             type.
50              
51             =over
52              
53             =item *
54              
55             For Amazon S3 bundles, set C<Password> to the appropriate IAM secret
56             access key.
57              
58             =item *
59              
60             For HTTP bundles and Subversion repositories, set C<Password> to the
61             password.
62              
63             =back
64              
65             For more information on how to safely handle IAM credentials, see
66             http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
67              
68             In responses, AWS OpsWorks Stacks returns C<*****FILTERED*****> instead
69             of the actual value.
70              
71              
72             =head2 Revision => Str
73              
74             The application's version. AWS OpsWorks Stacks enables you to easily
75             deploy new versions of an application. One of the simplest approaches
76             is to have branches or revisions in your repository that represent
77             different versions that can potentially be deployed.
78              
79              
80             =head2 SshKey => Str
81              
82             In requests, the repository's SSH key.
83              
84             In responses, AWS OpsWorks Stacks returns C<*****FILTERED*****> instead
85             of the actual value.
86              
87              
88             =head2 Type => Str
89              
90             The repository type.
91              
92              
93             =head2 Url => Str
94              
95             The source URL. The following is an example of an Amazon S3 source URL:
96             C<https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz>.
97              
98              
99             =head2 Username => Str
100              
101             This parameter depends on the repository type.
102              
103             =over
104              
105             =item *
106              
107             For Amazon S3 bundles, set C<Username> to the appropriate IAM access
108             key ID.
109              
110             =item *
111              
112             For HTTP bundles, Git repositories, and Subversion repositories, set
113             C<Username> to the user name.
114              
115             =back
116              
117              
118              
119              
120             =head1 SEE ALSO
121              
122             This class forms part of L<Paws>, describing an object used in L<Paws::OpsWorks>
123              
124             =head1 BUGS and CONTRIBUTIONS
125              
126             The source code is located here: https://github.com/pplu/aws-sdk-perl
127              
128             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
129              
130             =cut
131