AWS SDK for C++  1.8.98
AWS SDK for C++
Public Member Functions | List of all members
Aws::Firehose::Model::VpcConfigurationDescription Class Reference

#include <VpcConfigurationDescription.h>

Public Member Functions

 VpcConfigurationDescription ()
 
 VpcConfigurationDescription (Aws::Utils::Json::JsonView jsonValue)
 
VpcConfigurationDescriptionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< Aws::String > & GetSubnetIds () const
 
bool SubnetIdsHasBeenSet () const
 
void SetSubnetIds (const Aws::Vector< Aws::String > &value)
 
void SetSubnetIds (Aws::Vector< Aws::String > &&value)
 
VpcConfigurationDescriptionWithSubnetIds (const Aws::Vector< Aws::String > &value)
 
VpcConfigurationDescriptionWithSubnetIds (Aws::Vector< Aws::String > &&value)
 
VpcConfigurationDescriptionAddSubnetIds (const Aws::String &value)
 
VpcConfigurationDescriptionAddSubnetIds (Aws::String &&value)
 
VpcConfigurationDescriptionAddSubnetIds (const char *value)
 
const Aws::StringGetRoleARN () const
 
bool RoleARNHasBeenSet () const
 
void SetRoleARN (const Aws::String &value)
 
void SetRoleARN (Aws::String &&value)
 
void SetRoleARN (const char *value)
 
VpcConfigurationDescriptionWithRoleARN (const Aws::String &value)
 
VpcConfigurationDescriptionWithRoleARN (Aws::String &&value)
 
VpcConfigurationDescriptionWithRoleARN (const char *value)
 
const Aws::Vector< Aws::String > & GetSecurityGroupIds () const
 
bool SecurityGroupIdsHasBeenSet () const
 
void SetSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
VpcConfigurationDescriptionWithSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
VpcConfigurationDescriptionWithSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
VpcConfigurationDescriptionAddSecurityGroupIds (const Aws::String &value)
 
VpcConfigurationDescriptionAddSecurityGroupIds (Aws::String &&value)
 
VpcConfigurationDescriptionAddSecurityGroupIds (const char *value)
 
const Aws::StringGetVpcId () const
 
bool VpcIdHasBeenSet () const
 
void SetVpcId (const Aws::String &value)
 
void SetVpcId (Aws::String &&value)
 
void SetVpcId (const char *value)
 
VpcConfigurationDescriptionWithVpcId (const Aws::String &value)
 
VpcConfigurationDescriptionWithVpcId (Aws::String &&value)
 
VpcConfigurationDescriptionWithVpcId (const char *value)
 

Detailed Description

The details of the VPC of the Amazon ES destination.

See Also:

AWS API Reference

Definition at line 33 of file VpcConfigurationDescription.h.

Constructor & Destructor Documentation

◆ VpcConfigurationDescription() [1/2]

Aws::Firehose::Model::VpcConfigurationDescription::VpcConfigurationDescription ( )

◆ VpcConfigurationDescription() [2/2]

Aws::Firehose::Model::VpcConfigurationDescription::VpcConfigurationDescription ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddSecurityGroupIds() [1/3]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::AddSecurityGroupIds ( const Aws::String value)
inline

The IDs of the security groups that Kinesis Data Firehose uses 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, 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.

Definition at line 461 of file VpcConfigurationDescription.h.

◆ AddSecurityGroupIds() [2/3]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::AddSecurityGroupIds ( Aws::String &&  value)
inline

The IDs of the security groups that Kinesis Data Firehose uses 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, 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.

Definition at line 476 of file VpcConfigurationDescription.h.

◆ AddSecurityGroupIds() [3/3]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::AddSecurityGroupIds ( const char *  value)
inline

The IDs of the security groups that Kinesis Data Firehose uses 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, 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.

Definition at line 491 of file VpcConfigurationDescription.h.

◆ AddSubnetIds() [1/3]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::AddSubnetIds ( const Aws::String value)
inline

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. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

Definition at line 166 of file VpcConfigurationDescription.h.

◆ AddSubnetIds() [2/3]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::AddSubnetIds ( Aws::String &&  value)
inline

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. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

Definition at line 184 of file VpcConfigurationDescription.h.

◆ AddSubnetIds() [3/3]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::AddSubnetIds ( const char *  value)
inline

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. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

Definition at line 202 of file VpcConfigurationDescription.h.

◆ GetRoleARN()

const Aws::String& Aws::Firehose::Model::VpcConfigurationDescription::GetRoleARN ( ) const
inline

The ARN of the IAM role that the delivery stream uses 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.

Definition at line 222 of file VpcConfigurationDescription.h.

◆ GetSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::Firehose::Model::VpcConfigurationDescription::GetSecurityGroupIds ( ) const
inline

The IDs of the security groups that Kinesis Data Firehose uses 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, 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.

Definition at line 371 of file VpcConfigurationDescription.h.

◆ GetSubnetIds()

const Aws::Vector<Aws::String>& Aws::Firehose::Model::VpcConfigurationDescription::GetSubnetIds ( ) const
inline

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. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

Definition at line 58 of file VpcConfigurationDescription.h.

◆ GetVpcId()

const Aws::String& Aws::Firehose::Model::VpcConfigurationDescription::GetVpcId ( ) const
inline

The ID of the Amazon ES destination's VPC.

Definition at line 497 of file VpcConfigurationDescription.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Firehose::Model::VpcConfigurationDescription::Jsonize ( ) const

◆ operator=()

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleARNHasBeenSet()

bool Aws::Firehose::Model::VpcConfigurationDescription::RoleARNHasBeenSet ( ) const
inline

The ARN of the IAM role that the delivery stream uses 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.

Definition at line 241 of file VpcConfigurationDescription.h.

◆ SecurityGroupIdsHasBeenSet()

bool Aws::Firehose::Model::VpcConfigurationDescription::SecurityGroupIdsHasBeenSet ( ) const
inline

The IDs of the security groups that Kinesis Data Firehose uses 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, 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.

Definition at line 386 of file VpcConfigurationDescription.h.

◆ SetRoleARN() [1/3]

void Aws::Firehose::Model::VpcConfigurationDescription::SetRoleARN ( const Aws::String value)
inline

The ARN of the IAM role that the delivery stream uses 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.

Definition at line 260 of file VpcConfigurationDescription.h.

◆ SetRoleARN() [2/3]

void Aws::Firehose::Model::VpcConfigurationDescription::SetRoleARN ( Aws::String &&  value)
inline

The ARN of the IAM role that the delivery stream uses 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.

Definition at line 279 of file VpcConfigurationDescription.h.

◆ SetRoleARN() [3/3]

void Aws::Firehose::Model::VpcConfigurationDescription::SetRoleARN ( const char *  value)
inline

The ARN of the IAM role that the delivery stream uses 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.

Definition at line 298 of file VpcConfigurationDescription.h.

◆ SetSecurityGroupIds() [1/2]

void Aws::Firehose::Model::VpcConfigurationDescription::SetSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the security groups that Kinesis Data Firehose uses 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, 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.

Definition at line 401 of file VpcConfigurationDescription.h.

◆ SetSecurityGroupIds() [2/2]

void Aws::Firehose::Model::VpcConfigurationDescription::SetSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the security groups that Kinesis Data Firehose uses 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, 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.

Definition at line 416 of file VpcConfigurationDescription.h.

◆ SetSubnetIds() [1/2]

void Aws::Firehose::Model::VpcConfigurationDescription::SetSubnetIds ( const Aws::Vector< Aws::String > &  value)
inline

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. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

Definition at line 94 of file VpcConfigurationDescription.h.

◆ SetSubnetIds() [2/2]

void Aws::Firehose::Model::VpcConfigurationDescription::SetSubnetIds ( Aws::Vector< Aws::String > &&  value)
inline

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. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

Definition at line 112 of file VpcConfigurationDescription.h.

◆ SetVpcId() [1/3]

void Aws::Firehose::Model::VpcConfigurationDescription::SetVpcId ( const Aws::String value)
inline

The ID of the Amazon ES destination's VPC.

Definition at line 507 of file VpcConfigurationDescription.h.

◆ SetVpcId() [2/3]

void Aws::Firehose::Model::VpcConfigurationDescription::SetVpcId ( Aws::String &&  value)
inline

The ID of the Amazon ES destination's VPC.

Definition at line 512 of file VpcConfigurationDescription.h.

◆ SetVpcId() [3/3]

void Aws::Firehose::Model::VpcConfigurationDescription::SetVpcId ( const char *  value)
inline

The ID of the Amazon ES destination's VPC.

Definition at line 517 of file VpcConfigurationDescription.h.

◆ SubnetIdsHasBeenSet()

bool Aws::Firehose::Model::VpcConfigurationDescription::SubnetIdsHasBeenSet ( ) const
inline

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. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

Definition at line 76 of file VpcConfigurationDescription.h.

◆ VpcIdHasBeenSet()

bool Aws::Firehose::Model::VpcConfigurationDescription::VpcIdHasBeenSet ( ) const
inline

The ID of the Amazon ES destination's VPC.

Definition at line 502 of file VpcConfigurationDescription.h.

◆ WithRoleARN() [1/3]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::WithRoleARN ( const Aws::String value)
inline

The ARN of the IAM role that the delivery stream uses 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.

Definition at line 317 of file VpcConfigurationDescription.h.

◆ WithRoleARN() [2/3]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::WithRoleARN ( Aws::String &&  value)
inline

The ARN of the IAM role that the delivery stream uses 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.

Definition at line 336 of file VpcConfigurationDescription.h.

◆ WithRoleARN() [3/3]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::WithRoleARN ( const char *  value)
inline

The ARN of the IAM role that the delivery stream uses 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.

Definition at line 355 of file VpcConfigurationDescription.h.

◆ WithSecurityGroupIds() [1/2]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::WithSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the security groups that Kinesis Data Firehose uses 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, 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.

Definition at line 431 of file VpcConfigurationDescription.h.

◆ WithSecurityGroupIds() [2/2]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::WithSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the security groups that Kinesis Data Firehose uses 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, 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.

Definition at line 446 of file VpcConfigurationDescription.h.

◆ WithSubnetIds() [1/2]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::WithSubnetIds ( const Aws::Vector< Aws::String > &  value)
inline

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. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

Definition at line 130 of file VpcConfigurationDescription.h.

◆ WithSubnetIds() [2/2]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::WithSubnetIds ( Aws::Vector< Aws::String > &&  value)
inline

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. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

Definition at line 148 of file VpcConfigurationDescription.h.

◆ WithVpcId() [1/3]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::WithVpcId ( const Aws::String value)
inline

The ID of the Amazon ES destination's VPC.

Definition at line 522 of file VpcConfigurationDescription.h.

◆ WithVpcId() [2/3]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::WithVpcId ( Aws::String &&  value)
inline

The ID of the Amazon ES destination's VPC.

Definition at line 527 of file VpcConfigurationDescription.h.

◆ WithVpcId() [3/3]

VpcConfigurationDescription& Aws::Firehose::Model::VpcConfigurationDescription::WithVpcId ( const char *  value)
inline

The ID of the Amazon ES destination's VPC.

Definition at line 532 of file VpcConfigurationDescription.h.


The documentation for this class was generated from the following file: