com.amazonaws.services.ec2.model

Class CreateFlowLogsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateFlowLogsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateFlowLogsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateFlowLogs operation.

Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs.

In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs.

See Also:

AmazonEC2.createFlowLogs(CreateFlowLogsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateFlowLogsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateFlowLogsRequest	clone()
boolean	equals(Object obj)
String	getClientToken() Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
String	getDeliverLogsPermissionArn() The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.
String	getLogGroupName() The name of the CloudWatch log group.
List<String>	getResourceIds() One or more subnet, network interface, or VPC IDs.
String	getResourceType() The type of resource on which to create the flow log.
String	getTrafficType() The type of traffic to log.
int	hashCode()
void	setClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
void	setDeliverLogsPermissionArn(String deliverLogsPermissionArn) The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.
void	setLogGroupName(String logGroupName) The name of the CloudWatch log group.
void	setResourceIds(Collection<String> resourceIds) One or more subnet, network interface, or VPC IDs.
void	setResourceType(FlowLogsResourceType resourceType) The type of resource on which to create the flow log.
void	setResourceType(String resourceType) The type of resource on which to create the flow log.
void	setTrafficType(String trafficType) The type of traffic to log.
void	setTrafficType(TrafficType trafficType) The type of traffic to log.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateFlowLogsRequest	withClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
CreateFlowLogsRequest	withDeliverLogsPermissionArn(String deliverLogsPermissionArn) The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.
CreateFlowLogsRequest	withLogGroupName(String logGroupName) The name of the CloudWatch log group.
CreateFlowLogsRequest	withResourceIds(Collection<String> resourceIds) One or more subnet, network interface, or VPC IDs.
CreateFlowLogsRequest	withResourceIds(String... resourceIds) One or more subnet, network interface, or VPC IDs.
CreateFlowLogsRequest	withResourceType(FlowLogsResourceType resourceType) The type of resource on which to create the flow log.
CreateFlowLogsRequest	withResourceType(String resourceType) The type of resource on which to create the flow log.
CreateFlowLogsRequest	withTrafficType(String trafficType) The type of traffic to log.
CreateFlowLogsRequest	withTrafficType(TrafficType trafficType) The type of traffic to log.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateFlowLogsRequest

public CreateFlowLogsRequest()

Method Detail

getResourceIds

public List<String> getResourceIds()

One or more subnet, network interface, or VPC IDs.

Returns:

One or more subnet, network interface, or VPC IDs.

setResourceIds

public void setResourceIds(Collection<String> resourceIds)

One or more subnet, network interface, or VPC IDs.

Parameters:

resourceIds - One or more subnet, network interface, or VPC IDs.

withResourceIds

public CreateFlowLogsRequest withResourceIds(String... resourceIds)

One or more subnet, network interface, or VPC IDs.

NOTE: This method appends the values to the existing list (if any). Use setResourceIds(java.util.Collection) or withResourceIds(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

resourceIds - One or more subnet, network interface, or VPC IDs.

Returns:

A reference to this updated object so that method calls can be chained together.

withResourceIds

public CreateFlowLogsRequest withResourceIds(Collection<String> resourceIds)

One or more subnet, network interface, or VPC IDs.

Returns a reference to this object so that method calls can be chained together.

Parameters:

resourceIds - One or more subnet, network interface, or VPC IDs.

Returns:

A reference to this updated object so that method calls can be chained together.

getResourceType

public String getResourceType()

The type of resource on which to create the flow log.

Constraints:
Allowed Values: VPC, Subnet, NetworkInterface

Returns:

The type of resource on which to create the flow log.

See Also:

FlowLogsResourceType

setResourceType

public void setResourceType(String resourceType)

The type of resource on which to create the flow log.

Constraints:
Allowed Values: VPC, Subnet, NetworkInterface

Parameters:

resourceType - The type of resource on which to create the flow log.

See Also:

FlowLogsResourceType

withResourceType

public CreateFlowLogsRequest withResourceType(String resourceType)

The type of resource on which to create the flow log.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: VPC, Subnet, NetworkInterface

Parameters:

resourceType - The type of resource on which to create the flow log.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

FlowLogsResourceType

setResourceType

public void setResourceType(FlowLogsResourceType resourceType)

The type of resource on which to create the flow log.

Constraints:
Allowed Values: VPC, Subnet, NetworkInterface

Parameters:

resourceType - The type of resource on which to create the flow log.

See Also:

FlowLogsResourceType

withResourceType

public CreateFlowLogsRequest withResourceType(FlowLogsResourceType resourceType)

The type of resource on which to create the flow log.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: VPC, Subnet, NetworkInterface

Parameters:

resourceType - The type of resource on which to create the flow log.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

FlowLogsResourceType

getTrafficType

public String getTrafficType()

The type of traffic to log.

Constraints:
Allowed Values: ACCEPT, REJECT, ALL

Returns:

The type of traffic to log.

See Also:

TrafficType

setTrafficType

public void setTrafficType(String trafficType)

The type of traffic to log.

Constraints:
Allowed Values: ACCEPT, REJECT, ALL

Parameters:

trafficType - The type of traffic to log.

See Also:

TrafficType

withTrafficType

public CreateFlowLogsRequest withTrafficType(String trafficType)

The type of traffic to log.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ACCEPT, REJECT, ALL

Parameters:

trafficType - The type of traffic to log.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

TrafficType

setTrafficType

public void setTrafficType(TrafficType trafficType)

The type of traffic to log.

Constraints:
Allowed Values: ACCEPT, REJECT, ALL

Parameters:

trafficType - The type of traffic to log.

See Also:

TrafficType

withTrafficType

public CreateFlowLogsRequest withTrafficType(TrafficType trafficType)

The type of traffic to log.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ACCEPT, REJECT, ALL

Parameters:

trafficType - The type of traffic to log.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

TrafficType

getLogGroupName

public String getLogGroupName()

The name of the CloudWatch log group.

Returns:

The name of the CloudWatch log group.

setLogGroupName

public void setLogGroupName(String logGroupName)

The name of the CloudWatch log group.

Parameters:

logGroupName - The name of the CloudWatch log group.

withLogGroupName

public CreateFlowLogsRequest withLogGroupName(String logGroupName)

The name of the CloudWatch log group.

Returns a reference to this object so that method calls can be chained together.

Parameters:

logGroupName - The name of the CloudWatch log group.

Returns:

A reference to this updated object so that method calls can be chained together.

getDeliverLogsPermissionArn

public String getDeliverLogsPermissionArn()

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

Returns:

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

setDeliverLogsPermissionArn

public void setDeliverLogsPermissionArn(String deliverLogsPermissionArn)

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

Parameters:

deliverLogsPermissionArn - The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

withDeliverLogsPermissionArn

public CreateFlowLogsRequest withDeliverLogsPermissionArn(String deliverLogsPermissionArn)

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

Returns a reference to this object so that method calls can be chained together.

Parameters:

deliverLogsPermissionArn - The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientToken

public String getClientToken()

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Returns:

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

setClientToken

public void setClientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

withClientToken

public CreateFlowLogsRequest withClientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Returns a reference to this object so that method calls can be chained together.

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public CreateFlowLogsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest