Class: Aws::Firehose::Types::VpcConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-firehose/types.rb

Overview

The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#role_arn ⇒ String

The ARN of the IAM role that you want the Firehose stream to use to create endpoints in the destination VPC. You can use your existing Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the 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`

When you specify subnets for delivering data to the destination in a private VPC, make sure you have enough number of free IP addresses in chosen subnets. If there is no available free IP address in a specified subnet, Firehose cannot create or add ENIs for the data delivery in the private VPC, and the delivery will be degraded or fail.

Returns:

  • (String) 


5670
5671
5672
5673
5674
5675
5676
 
# File 'lib/aws-sdk-firehose/types.rb', line 5670

class VpcConfiguration < Struct.new(
  :subnet_ids,
  :role_arn,
  :security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

The IDs of the security groups that you want 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.

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules

Returns:

  • (Array<String>) 


5670
5671
5672
5673
5674
5675
5676
 
# File 'lib/aws-sdk-firehose/types.rb', line 5670

class VpcConfiguration < Struct.new(
  :subnet_ids,
  :role_arn,
  :security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

The IDs of the subnets that you want 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. 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 Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable 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 Firehose can create up to three ENIs for this Firehose stream for each of the subnets specified here. For more information about ENI quota, see [Network Interfaces ][1] in the Amazon VPC Quotas topic.

[1]: docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis

Returns:

  • (Array<String>) 


5670
5671
5672
5673
5674
5675
5676
 
# File 'lib/aws-sdk-firehose/types.rb', line 5670

class VpcConfiguration < Struct.new(
  :subnet_ids,
  :role_arn,
  :security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end