« blib/lib/Paws/Firehose/VpcConfiguration.pm
↑ Summary
blib/lib/Paws/Forecast/CategoricalParameterRange.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Firehose::VpcConfigurationDescription; | ||
| 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 | has VpcId => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Firehose::VpcConfigurationDescription | ||
| 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::Firehose::VpcConfigurationDescription object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { RoleARN => $value, ..., VpcId => $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::Firehose::VpcConfigurationDescription object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->RoleARN | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | The details of the VPC of the Amazon ES destination. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> RoleARN => Str | ||
| 45 | |||
| 46 | The ARN of the IAM role that the delivery stream uses to create | ||
| 47 | endpoints in the destination VPC. You can use your existing Kinesis | ||
| 48 | Data Firehose delivery role or you can specify a new role. In either | ||
| 49 | case, make sure that the role trusts the Kinesis Data Firehose service | ||
| 50 | principal and that it grants the following permissions: | ||
| 51 | |||
| 52 | =over | ||
| 53 | |||
| 54 | =item * | ||
| 55 | |||
| 56 | C<ec2:DescribeVpcs> | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | C<ec2:DescribeVpcAttribute> | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | C<ec2:DescribeSubnets> | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<ec2:DescribeSecurityGroups> | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<ec2:DescribeNetworkInterfaces> | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<ec2:CreateNetworkInterface> | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | C<ec2:CreateNetworkInterfacePermission> | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<ec2:DeleteNetworkInterface> | ||
| 85 | |||
| 86 | =back | ||
| 87 | |||
| 88 | If you revoke these permissions after you create the delivery stream, | ||
| 89 | Kinesis Data Firehose can't scale out by creating more ENIs when | ||
| 90 | necessary. You might therefore see a degradation in performance. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> SecurityGroupIds => ArrayRef[Str|Undef] | ||
| 94 | |||
| 95 | The IDs of the security groups that Kinesis Data Firehose uses when it | ||
| 96 | creates ENIs in the VPC of the Amazon ES destination. You can use the | ||
| 97 | same security group that the Amazon ES domain uses or different ones. | ||
| 98 | If you specify different security groups, ensure that they allow | ||
| 99 | outbound HTTPS traffic to the Amazon ES domain's security group. Also | ||
| 100 | ensure that the Amazon ES domain's security group allows HTTPS traffic | ||
| 101 | from the security groups specified here. If you use the same security | ||
| 102 | group for both your delivery stream and the Amazon ES domain, make sure | ||
| 103 | the security group inbound rule allows HTTPS traffic. For more | ||
| 104 | information about security group rules, see 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 Kinesis Data Firehose uses to create ENIs | ||
| 112 | in the VPC of the Amazon ES destination. Make sure that the routing | ||
| 113 | tables and inbound and outbound rules allow traffic to flow from the | ||
| 114 | subnets whose IDs are specified here to the subnets that have the | ||
| 115 | destination Amazon ES endpoints. Kinesis Data Firehose creates at least | ||
| 116 | one ENI in each of the subnets that are specified here. Do not delete | ||
| 117 | 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 | =head2 B<REQUIRED> VpcId => Str | ||
| 132 | |||
| 133 | The ID of the Amazon ES destination's VPC. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head1 SEE ALSO | ||
| 138 | |||
| 139 | This class forms part of L<Paws>, describing an object used in L<Paws::Firehose> | ||
| 140 | |||
| 141 | =head1 BUGS and CONTRIBUTIONS | ||
| 142 | |||
| 143 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 144 | |||
| 145 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 146 | |||
| 147 | =cut | ||
| 148 |