VpcConfigurationDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesisfirehose.model.VpcConfigurationDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class VpcConfigurationDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

The details of the VPC of the Amazon ES destination.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

VpcConfigurationDescription()

Constructors
Constructor and Description
`VpcConfigurationDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VpcConfigurationDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getRoleARN()` The ARN of the IAM role that you want the delivery stream uses to create endpoints in the destination VPC.
`List<String>`	`getSecurityGroupIds()` The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.
`List<String>`	`getSubnetIds()` The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination.
`String`	`getVpcId()` The ID of the Amazon ES destination's VPC.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setRoleARN(String roleARN)` The ARN of the IAM role that you want the delivery stream uses to create endpoints in the destination VPC.
`void`	`setSecurityGroupIds(Collection<String> securityGroupIds)` The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.
`void`	`setSubnetIds(Collection<String> subnetIds)` The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination.
`void`	`setVpcId(String vpcId)` The ID of the Amazon ES destination's VPC.
`String`	`toString()` Returns a string representation of this object.
`VpcConfigurationDescription`	`withRoleARN(String roleARN)` The ARN of the IAM role that you want the delivery stream uses to create endpoints in the destination VPC.
`VpcConfigurationDescription`	`withSecurityGroupIds(Collection<String> securityGroupIds)` The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.
`VpcConfigurationDescription`	`withSecurityGroupIds(String... securityGroupIds)` The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.
`VpcConfigurationDescription`	`withSubnetIds(Collection<String> subnetIds)` The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination.
`VpcConfigurationDescription`	`withSubnetIds(String... subnetIds)` The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination.
`VpcConfigurationDescription`	`withVpcId(String vpcId)` The ID of the Amazon ES destination's VPC.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VpcConfigurationDescription
```
public VpcConfigurationDescription()
```
- Method Detail
  - getSubnetIds
```
public 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. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
    
    Returns:
    
    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.
  - setSubnetIds
```
public void setSubnetIds(Collection<String> subnetIds)
```
    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.
    
    Parameters:
    
    subnetIds - 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.
  - withSubnetIds
```
public VpcConfigurationDescription withSubnetIds(String... subnetIds)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    subnetIds - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSubnetIds
```
public VpcConfigurationDescription withSubnetIds(Collection<String> subnetIds)
```
    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.
    
    Parameters:
    
    subnetIds - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleARN
```
public void setRoleARN(String roleARN)
```
    The ARN of the IAM role that you want the delivery stream uses to create endpoints in the destination VPC.
    
    Parameters:
    
    roleARN - The ARN of the IAM role that you want the delivery stream uses to create endpoints in the destination VPC.
  - getRoleARN
```
public String getRoleARN()
```
    The ARN of the IAM role that you want the delivery stream uses to create endpoints in the destination VPC.
    
    Returns:
    
    The ARN of the IAM role that you want the delivery stream uses to create endpoints in the destination VPC.
  - withRoleARN
```
public VpcConfigurationDescription withRoleARN(String roleARN)
```
    The ARN of the IAM role that you want the delivery stream uses to create endpoints in the destination VPC.
    
    Parameters:
    
    roleARN - The ARN of the IAM role that you want the delivery stream uses to create endpoints in the destination VPC.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSecurityGroupIds
```
public List<String> getSecurityGroupIds()
```
    The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.
    
    Returns:
    
    The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.
  - setSecurityGroupIds
```
public void setSecurityGroupIds(Collection<String> securityGroupIds)
```
    The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.
    
    Parameters:
    
    securityGroupIds - The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.
  - withSecurityGroupIds
```
public VpcConfigurationDescription withSecurityGroupIds(String... securityGroupIds)
```
    The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.
    
    NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    securityGroupIds - The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSecurityGroupIds
```
public VpcConfigurationDescription withSecurityGroupIds(Collection<String> securityGroupIds)
```
    The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.
    
    Parameters:
    
    securityGroupIds - The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcId
```
public void setVpcId(String vpcId)
```
    The ID of the Amazon ES destination's VPC.
    
    Parameters:
    
    vpcId - The ID of the Amazon ES destination's VPC.
  - getVpcId
```
public String getVpcId()
```
    The ID of the Amazon ES destination's VPC.
    
    Returns:
    
    The ID of the Amazon ES destination's VPC.
  - withVpcId
```
public VpcConfigurationDescription withVpcId(String vpcId)
```
    The ID of the Amazon ES destination's VPC.
    
    Parameters:
    
    vpcId - The ID of the Amazon ES destination's VPC.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public VpcConfigurationDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class VpcConfigurationDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VpcConfigurationDescription

Method Detail

getSubnetIds

setSubnetIds

withSubnetIds

withSubnetIds

setRoleARN

getRoleARN

withRoleARN

getSecurityGroupIds

setSecurityGroupIds

withSecurityGroupIds

withSecurityGroupIds

setVpcId

getVpcId

withVpcId

toString

equals

hashCode

clone

marshall