Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Firehose.Types.VpcConfiguration

Description

Synopsis

Documentation

data VpcConfiguration Source #

The details of the VPC of the Amazon ES destination.

See: newVpcConfiguration smart constructor.

Constructors

VpcConfiguration'

Fields

subnetIds :: NonEmpty Text
The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.
The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
roleARN :: Text
The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:
- ```
ec2:DescribeVpcs
```
- ```
ec2:DescribeVpcAttribute
```
- ```
ec2:DescribeSubnets
```
- ```
ec2:DescribeSecurityGroups
```
- ```
ec2:DescribeNetworkInterfaces
```
- ```
ec2:CreateNetworkInterface
```
- ```
ec2:CreateNetworkInterfacePermission
```
- ```
ec2:DeleteNetworkInterface
```
If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
securityGroupIds :: NonEmpty Text
The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.

Instances

Instances details

Eq VpcConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.VpcConfiguration Methods (==) :: VpcConfiguration -> VpcConfiguration -> Bool # (/=) :: VpcConfiguration -> VpcConfiguration -> Bool #
Read VpcConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.VpcConfiguration Methods readsPrec :: Int -> ReadS VpcConfiguration # readList :: ReadS [VpcConfiguration] # readPrec :: ReadPrec VpcConfiguration # readListPrec :: ReadPrec [VpcConfiguration] #
Show VpcConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.VpcConfiguration Methods showsPrec :: Int -> VpcConfiguration -> ShowS # show :: VpcConfiguration -> String # showList :: [VpcConfiguration] -> ShowS #
Generic VpcConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.VpcConfiguration Associated Types type Rep VpcConfiguration :: Type -> Type # Methods from :: VpcConfiguration -> Rep VpcConfiguration x # to :: Rep VpcConfiguration x -> VpcConfiguration #
NFData VpcConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.VpcConfiguration Methods rnf :: VpcConfiguration -> () #
Hashable VpcConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.VpcConfiguration Methods hashWithSalt :: Int -> VpcConfiguration -> Int # hash :: VpcConfiguration -> Int #
ToJSON VpcConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.VpcConfiguration Methods toJSON :: VpcConfiguration -> Value # toEncoding :: VpcConfiguration -> Encoding # toJSONList :: [VpcConfiguration] -> Value # toEncodingList :: [VpcConfiguration] -> Encoding #
type Rep VpcConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.VpcConfiguration type Rep VpcConfiguration = D1 ('MetaData "VpcConfiguration" "Amazonka.Firehose.Types.VpcConfiguration" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "VpcConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))))

newVpcConfiguration Source #

Arguments

:: NonEmpty Text	`$sel:subnetIds:VpcConfiguration'`
-> Text	`$sel:roleARN:VpcConfiguration'`
-> NonEmpty Text	`$sel:securityGroupIds:VpcConfiguration'`
-> VpcConfiguration

Create a value of VpcConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:subnetIds:VpcConfiguration', vpcConfiguration_subnetIds - The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.

The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

$sel:roleARN:VpcConfiguration', vpcConfiguration_roleARN - The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:

```
ec2:DescribeVpcs
```
```
ec2:DescribeVpcAttribute
```
```
ec2:DescribeSubnets
```
```
ec2:DescribeSecurityGroups
```
```
ec2:DescribeNetworkInterfaces
```
```
ec2:CreateNetworkInterface
```
```
ec2:CreateNetworkInterfacePermission
```
```
ec2:DeleteNetworkInterface
```

If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

$sel:securityGroupIds:VpcConfiguration', vpcConfiguration_securityGroupIds - The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.

vpcConfiguration_subnetIds :: Lens' VpcConfiguration (NonEmpty Text) Source #

The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.

The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

vpcConfiguration_roleARN :: Lens' VpcConfiguration Text Source #

The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:

```
ec2:DescribeVpcs
```
```
ec2:DescribeVpcAttribute
```
```
ec2:DescribeSubnets
```
```
ec2:DescribeSecurityGroups
```
```
ec2:DescribeNetworkInterfaces
```
```
ec2:CreateNetworkInterface
```
```
ec2:CreateNetworkInterfacePermission
```
```
ec2:DeleteNetworkInterface
```

If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

vpcConfiguration_securityGroupIds :: Lens' VpcConfiguration (NonEmpty Text) Source #

The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.