Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.VpcConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDeliveryStream.VpcConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnDeliveryStream
@Stability(Stable) public static interface CfnDeliveryStream.VpcConfigurationProperty extends software.amazon.jsii.JsiiSerializable
The details of the VPC of the Amazon ES destination.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesisfirehose.*;
 VpcConfigurationProperty vpcConfigurationProperty = VpcConfigurationProperty.builder()
         .roleArn("roleArn")
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetIds(List.of("subnetIds"))
         .build();

  • Method Details

    • getRoleArn

      @Stability(Stable) @NotNull String getRoleArn()
      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.

    • getSecurityGroupIds

      @Stability(Stable) @NotNull List<String> getSecurityGroupIds()
      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.

    • getSubnetIds

      @Stability(Stable) @NotNull List<String> getSubnetIds()
      The IDs of the subnets that Kinesis Data Firehose uses 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.

    • builder

      @Stability(Stable) static CfnDeliveryStream.VpcConfigurationProperty.Builder builder()
      Returns:
      a CfnDeliveryStream.VpcConfigurationProperty.Builder of CfnDeliveryStream.VpcConfigurationProperty