blib/lib/Paws/Firehose/VpcConfiguration.pm untested

filter: Statementstmt 0.0% 0 / 6 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 7 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Firehose::VpcConfiguration;
3 use Moose;
4 has RoleARN => (is => 'ro', isa => 'Str', required => 1);
5 has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
6 has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
7  
8 1;
9  
10 ### main pod documentation begin ###
11  
12 =head1 NAME
13  
14 Paws::Firehose::VpcConfiguration
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::Firehose::VpcConfiguration object:
26  
27 $service_obj->Method(Att1 => { RoleARN => $value, ..., SubnetIds => $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::Firehose::VpcConfiguration object:
32  
33 $result = $service_obj->Method(...);
34 $result->Att1->RoleARN
35  
36 =head1 DESCRIPTION
37  
38 The details of the VPC of the Amazon ES destination.
39  
40 =head1 ATTRIBUTES
41  
42  
43 =head2 B<REQUIRED> RoleARN => Str
44  
45 The ARN of the IAM role that you want the delivery stream to use to
46 create endpoints in the destination VPC. You can use your existing
47 Kinesis Data Firehose delivery role or you can specify a new role. In
48 either case, make sure that the role trusts the Kinesis Data Firehose
49 service principal and that it grants the following permissions:
50  
51 =over
52  
53 =item *
54  
55 C<ec2:DescribeVpcs>
56  
57 =item *
58  
59 C<ec2:DescribeVpcAttribute>
60  
61 =item *
62  
63 C<ec2:DescribeSubnets>
64  
65 =item *
66  
67 C<ec2:DescribeSecurityGroups>
68  
69 =item *
70  
71 C<ec2:DescribeNetworkInterfaces>
72  
73 =item *
74  
75 C<ec2:CreateNetworkInterface>
76  
77 =item *
78  
79 C<ec2:CreateNetworkInterfacePermission>
80  
81 =item *
82  
83 C<ec2:DeleteNetworkInterface>
84  
85 =back
86  
87 If you revoke these permissions after you create the delivery stream,
88 Kinesis Data Firehose can't scale out by creating more ENIs when
89 necessary. You might therefore see a degradation in performance.
90  
91  
92 =head2 B<REQUIRED> SecurityGroupIds => ArrayRef[Str|Undef]
93  
94 The IDs of the security groups that you want Kinesis Data Firehose to
95 use when it creates ENIs in the VPC of the Amazon ES destination. You
96 can use the same security group that the Amazon ES domain uses or
97 different ones. If you specify different security groups here, ensure
98 that they allow outbound HTTPS traffic to the Amazon ES domain's
99 security group. Also ensure that the Amazon ES domain's security group
100 allows HTTPS traffic from the security groups specified here. If you
101 use the same security group for both your delivery stream and the
102 Amazon ES domain, make sure the security group inbound rule allows
103 HTTPS traffic. For more information about security group rules, see
104 Security group rules
105 (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules)
106 in the Amazon VPC documentation.
107  
108  
109 =head2 B<REQUIRED> SubnetIds => ArrayRef[Str|Undef]
110  
111 The IDs of the subnets that you want Kinesis Data Firehose to use to
112 create ENIs in the VPC of the Amazon ES destination. Make sure that the
113 routing tables and inbound and outbound rules allow traffic to flow
114 from the subnets whose IDs are specified here to the subnets that have
115 the destination Amazon ES endpoints. Kinesis Data Firehose creates at
116 least one ENI in each of the subnets that are specified here. Do not
117 delete or modify these ENIs.
118  
119 The number of ENIs that Kinesis Data Firehose creates in the subnets
120 specified here scales up and down automatically based on throughput. To
121 enable Kinesis Data Firehose to scale up the number of ENIs to match
122 throughput, ensure that you have sufficient quota. To help you
123 calculate the quota you need, assume that Kinesis Data Firehose can
124 create up to three ENIs for this delivery stream for each of the
125 subnets specified here. For more information about ENI quota, see
126 Network Interfaces
127 (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis)
128 in the Amazon VPC Quotas topic.
129  
130  
131  
132 =head1 SEE ALSO
133  
134 This class forms part of L<Paws>, describing an object used in L<Paws::Firehose>
135  
136 =head1 BUGS and CONTRIBUTIONS
137  
138 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
139  
140 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
141  
142 =cut
143