File Coverage

blib/lib/Paws/CodePipeline/ActionConfigurationProperty.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	sub	time	code
1				package Paws::CodePipeline::ActionConfigurationProperty;
2	1	1	684	use Moose;
	1		3
	1		10
3				has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']);
4				has Key => (is => 'ro', isa => 'Bool', request_name => 'key', traits => ['NameInRequest'], required => 1);
5				has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1);
6				has Queryable => (is => 'ro', isa => 'Bool', request_name => 'queryable', traits => ['NameInRequest']);
7				has Required => (is => 'ro', isa => 'Bool', request_name => 'required', traits => ['NameInRequest'], required => 1);
8				has Secret => (is => 'ro', isa => 'Bool', request_name => 'secret', traits => ['NameInRequest'], required => 1);
9				has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest']);
10				1;
11
12				### main pod documentation begin ###
13
14				=head1 NAME
15
16				Paws::CodePipeline::ActionConfigurationProperty
17
18				=head1 USAGE
19
20				This class represents one of two things:
21
22				=head3 Arguments in a call to a service
23
24				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25				Each attribute should be used as a named argument in the calls that expect this type of object.
26
27				As an example, if Att1 is expected to be a Paws::CodePipeline::ActionConfigurationProperty object:
28
29				$service_obj->Method(Att1 => { Description => $value, ..., Type => $value });
30
31				=head3 Results returned from an API call
32
33				Use accessors for each attribute. If Att1 is expected to be an Paws::CodePipeline::ActionConfigurationProperty object:
34
35				$result = $service_obj->Method(...);
36				$result->Att1->Description
37
38				=head1 DESCRIPTION
39
40				Represents information about an action configuration property.
41
42				=head1 ATTRIBUTES
43
44
45				=head2 Description => Str
46
47				The description of the action configuration property that will be
48				displayed to users.
49
50
51				=head2 B<REQUIRED> Key => Bool
52
53				Whether the configuration property is a key.
54
55
56				=head2 B<REQUIRED> Name => Str
57
58				The name of the action configuration property.
59
60
61				=head2 Queryable => Bool
62
63				Indicates that the proprety will be used in conjunction with
64				PollForJobs. When creating a custom action, an action can have up to
65				one queryable property. If it has one, that property must be both
66				required and not secret.
67
68				If you create a pipeline with a custom action type, and that custom
69				action contains a queryable property, the value for that configuration
70				property is subject to additional restrictions. The value must be less
71				than or equal to twenty (20) characters. The value can contain only
72				alphanumeric characters, underscores, and hyphens.
73
74
75				=head2 B<REQUIRED> Required => Bool
76
77				Whether the configuration property is a required value.
78
79
80				=head2 B<REQUIRED> Secret => Bool
81
82				Whether the configuration property is secret. Secrets are hidden from
83				all calls except for GetJobDetails, GetThirdPartyJobDetails,
84				PollForJobs, and PollForThirdPartyJobs.
85
86				When updating a pipeline, passing * * * * * without changing any other
87				values of the action will preserve the prior value of the secret.
88
89
90				=head2 Type => Str
91
92				The type of the configuration property.
93
94
95
96				=head1 SEE ALSO
97
98				This class forms part of L<Paws>, describing an object used in L<Paws::CodePipeline>
99
100				=head1 BUGS and CONTRIBUTIONS
101
102				The source code is located here: https://github.com/pplu/aws-sdk-perl
103
104				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
105
106				=cut
107