com.amazonaws.services.ec2.model

Class CreateFlowLogsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateFlowLogsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<CreateFlowLogsRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateFlowLogsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<CreateFlowLogsRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateFlowLogsRequest()

Method Summary

Modifier and Type	Method and Description
CreateFlowLogsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getDeliverCrossAccountRole() The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
String	getDeliverLogsPermissionArn() The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.
DestinationOptionsRequest	getDestinationOptions() The destination options.
Request<CreateFlowLogsRequest>	getDryRunRequest() This method is intended for internal use only.
String	getLogDestination() The destination for the flow log data.
String	getLogDestinationType() The type of destination for the flow log data.
String	getLogFormat() The fields to include in the flow log record.
String	getLogGroupName() The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
Integer	getMaxAggregationInterval() The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
List<String>	getResourceIds() The IDs of the resources to monitor.
String	getResourceType() The type of resource to monitor.
List<TagSpecification>	getTagSpecifications() The tags to apply to the flow logs.
String	getTrafficType() The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).
int	hashCode()
void	setClientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setDeliverCrossAccountRole(String deliverCrossAccountRole) The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
void	setDeliverLogsPermissionArn(String deliverLogsPermissionArn) The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.
void	setDestinationOptions(DestinationOptionsRequest destinationOptions) The destination options.
void	setLogDestination(String logDestination) The destination for the flow log data.
void	setLogDestinationType(LogDestinationType logDestinationType) The type of destination for the flow log data.
void	setLogDestinationType(String logDestinationType) The type of destination for the flow log data.
void	setLogFormat(String logFormat) The fields to include in the flow log record.
void	setLogGroupName(String logGroupName) The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
void	setMaxAggregationInterval(Integer maxAggregationInterval) The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
void	setResourceIds(Collection<String> resourceIds) The IDs of the resources to monitor.
void	setResourceType(FlowLogsResourceType resourceType) The type of resource to monitor.
void	setResourceType(String resourceType) The type of resource to monitor.
void	setTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the flow logs.
void	setTrafficType(String trafficType) The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).
void	setTrafficType(TrafficType trafficType) The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).
String	toString() Returns a string representation of this object.
CreateFlowLogsRequest	withClientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateFlowLogsRequest	withDeliverCrossAccountRole(String deliverCrossAccountRole) The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
CreateFlowLogsRequest	withDeliverLogsPermissionArn(String deliverLogsPermissionArn) The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.
CreateFlowLogsRequest	withDestinationOptions(DestinationOptionsRequest destinationOptions) The destination options.
CreateFlowLogsRequest	withLogDestination(String logDestination) The destination for the flow log data.
CreateFlowLogsRequest	withLogDestinationType(LogDestinationType logDestinationType) The type of destination for the flow log data.
CreateFlowLogsRequest	withLogDestinationType(String logDestinationType) The type of destination for the flow log data.
CreateFlowLogsRequest	withLogFormat(String logFormat) The fields to include in the flow log record.
CreateFlowLogsRequest	withLogGroupName(String logGroupName) The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
CreateFlowLogsRequest	withMaxAggregationInterval(Integer maxAggregationInterval) The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
CreateFlowLogsRequest	withResourceIds(Collection<String> resourceIds) The IDs of the resources to monitor.
CreateFlowLogsRequest	withResourceIds(String... resourceIds) The IDs of the resources to monitor.
CreateFlowLogsRequest	withResourceType(FlowLogsResourceType resourceType) The type of resource to monitor.
CreateFlowLogsRequest	withResourceType(String resourceType) The type of resource to monitor.
CreateFlowLogsRequest	withTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the flow logs.
CreateFlowLogsRequest	withTagSpecifications(TagSpecification... tagSpecifications) The tags to apply to the flow logs.
CreateFlowLogsRequest	withTrafficType(String trafficType) The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).
CreateFlowLogsRequest	withTrafficType(TrafficType trafficType) The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateFlowLogsRequest

public CreateFlowLogsRequest()

Method Detail

setClientToken

public void setClientToken(String clientToken)

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

Parameters:

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

getClientToken

public String getClientToken()

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

Returns:

Unique, case-sensitive identifier that 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 that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Parameters:

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

Returns:

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

setDeliverLogsPermissionArn

public void setDeliverLogsPermissionArn(String deliverLogsPermissionArn)

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.

This parameter is required if the destination type is cloud-watch-logs, or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.

Parameters:

deliverLogsPermissionArn - The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.

This parameter is required if the destination type is cloud-watch-logs, or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.

getDeliverLogsPermissionArn

public String getDeliverLogsPermissionArn()

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.

This parameter is required if the destination type is cloud-watch-logs, or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.

Returns:

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.

This parameter is required if the destination type is cloud-watch-logs, or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.

withDeliverLogsPermissionArn

public CreateFlowLogsRequest withDeliverLogsPermissionArn(String deliverLogsPermissionArn)

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.

This parameter is required if the destination type is cloud-watch-logs, or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.

Parameters:

deliverLogsPermissionArn - The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.

This parameter is required if the destination type is cloud-watch-logs, or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.

Returns:

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

setDeliverCrossAccountRole

public void setDeliverCrossAccountRole(String deliverCrossAccountRole)

The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.

Parameters:

deliverCrossAccountRole - The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.

getDeliverCrossAccountRole

public String getDeliverCrossAccountRole()

The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.

Returns:

The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.

withDeliverCrossAccountRole

public CreateFlowLogsRequest withDeliverCrossAccountRole(String deliverCrossAccountRole)

The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.

Parameters:

deliverCrossAccountRole - The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.

Returns:

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

setLogGroupName

public void setLogGroupName(String logGroupName)

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

This parameter is valid only if the destination type is cloud-watch-logs.

Parameters:

logGroupName - The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

This parameter is valid only if the destination type is cloud-watch-logs.

getLogGroupName

public String getLogGroupName()

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

This parameter is valid only if the destination type is cloud-watch-logs.

Returns:

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

This parameter is valid only if the destination type is cloud-watch-logs.

withLogGroupName

public CreateFlowLogsRequest withLogGroupName(String logGroupName)

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

This parameter is valid only if the destination type is cloud-watch-logs.

Parameters:

logGroupName - The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

This parameter is valid only if the destination type is cloud-watch-logs.

Returns:

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

getResourceIds

public List<String> getResourceIds()

The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

Returns:

The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

setResourceIds

public void setResourceIds(Collection<String> resourceIds)

The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

Parameters:

resourceIds - The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

withResourceIds

public CreateFlowLogsRequest withResourceIds(String... resourceIds)

The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

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.

Parameters:

resourceIds - The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

Returns:

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

withResourceIds

public CreateFlowLogsRequest withResourceIds(Collection<String> resourceIds)

The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

Parameters:

resourceIds - The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

Returns:

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

setResourceType

public void setResourceType(String resourceType)

The type of resource to monitor.

Parameters:

resourceType - The type of resource to monitor.

See Also:

FlowLogsResourceType

getResourceType

public String getResourceType()

The type of resource to monitor.

Returns:

The type of resource to monitor.

See Also:

FlowLogsResourceType

withResourceType

public CreateFlowLogsRequest withResourceType(String resourceType)

The type of resource to monitor.

Parameters:

resourceType - The type of resource to monitor.

Returns:

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

See Also:

FlowLogsResourceType

setResourceType

public void setResourceType(FlowLogsResourceType resourceType)

The type of resource to monitor.

Parameters:

resourceType - The type of resource to monitor.

See Also:

FlowLogsResourceType

withResourceType

public CreateFlowLogsRequest withResourceType(FlowLogsResourceType resourceType)

The type of resource to monitor.

Parameters:

resourceType - The type of resource to monitor.

Returns:

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

See Also:

FlowLogsResourceType

setTrafficType

public void setTrafficType(String trafficType)

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

Parameters:

trafficType - The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

See Also:

TrafficType

getTrafficType

public String getTrafficType()

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

Returns:

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

See Also:

TrafficType

withTrafficType

public CreateFlowLogsRequest withTrafficType(String trafficType)

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

Parameters:

trafficType - The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

Returns:

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

See Also:

TrafficType

setTrafficType

public void setTrafficType(TrafficType trafficType)

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

Parameters:

trafficType - The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

See Also:

TrafficType

withTrafficType

public CreateFlowLogsRequest withTrafficType(TrafficType trafficType)

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

Parameters:

trafficType - The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

Returns:

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

See Also:

TrafficType

setLogDestinationType

public void setLogDestinationType(String logDestinationType)

The type of destination for the flow log data.

Default: cloud-watch-logs

Parameters:

logDestinationType - The type of destination for the flow log data.

Default: cloud-watch-logs

See Also:

LogDestinationType

getLogDestinationType

public String getLogDestinationType()

The type of destination for the flow log data.

Default: cloud-watch-logs

Returns:

The type of destination for the flow log data.

Default: cloud-watch-logs

See Also:

LogDestinationType

withLogDestinationType

public CreateFlowLogsRequest withLogDestinationType(String logDestinationType)

The type of destination for the flow log data.

Default: cloud-watch-logs

Parameters:

logDestinationType - The type of destination for the flow log data.

Default: cloud-watch-logs

Returns:

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

See Also:

LogDestinationType

setLogDestinationType

public void setLogDestinationType(LogDestinationType logDestinationType)

The type of destination for the flow log data.

Default: cloud-watch-logs

Parameters:

logDestinationType - The type of destination for the flow log data.

Default: cloud-watch-logs

See Also:

LogDestinationType

withLogDestinationType

public CreateFlowLogsRequest withLogDestinationType(LogDestinationType logDestinationType)

The type of destination for the flow log data.

Default: cloud-watch-logs

Parameters:

logDestinationType - The type of destination for the flow log data.

Default: cloud-watch-logs

Returns:

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

See Also:

LogDestinationType

setLogDestination

public void setLogDestination(String logDestination)

The destination for the flow log data. The meaning of this parameter depends on the destination type.

• If the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:

  arn:aws:logs:region:account_id:log-group:my_group

  Alternatively, use the LogGroupName parameter.

• If the destination type is s3, specify the ARN of an S3 bucket. For example:

  arn:aws:s3:::my_bucket/my_subfolder/

  The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.

• If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:

  arn:aws:firehose:region:account_id:deliverystream:my_stream

Parameters:

logDestination - The destination for the flow log data. The meaning of this parameter depends on the destination type.

• If the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:

  arn:aws:logs:region:account_id:log-group:my_group

  Alternatively, use the LogGroupName parameter.

• If the destination type is s3, specify the ARN of an S3 bucket. For example:

  arn:aws:s3:::my_bucket/my_subfolder/

  The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.

• If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:

  arn:aws:firehose:region:account_id:deliverystream:my_stream

getLogDestination

public String getLogDestination()

The destination for the flow log data. The meaning of this parameter depends on the destination type.

• If the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:

  arn:aws:logs:region:account_id:log-group:my_group

  Alternatively, use the LogGroupName parameter.

• If the destination type is s3, specify the ARN of an S3 bucket. For example:

  arn:aws:s3:::my_bucket/my_subfolder/

  The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.

• If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:

  arn:aws:firehose:region:account_id:deliverystream:my_stream

Returns:

The destination for the flow log data. The meaning of this parameter depends on the destination type.

• If the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:

  arn:aws:logs:region:account_id:log-group:my_group

  Alternatively, use the LogGroupName parameter.

• If the destination type is s3, specify the ARN of an S3 bucket. For example:

  arn:aws:s3:::my_bucket/my_subfolder/

  The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.

• If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:

  arn:aws:firehose:region:account_id:deliverystream:my_stream

withLogDestination

public CreateFlowLogsRequest withLogDestination(String logDestination)

The destination for the flow log data. The meaning of this parameter depends on the destination type.

• If the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:

  arn:aws:logs:region:account_id:log-group:my_group

  Alternatively, use the LogGroupName parameter.

• If the destination type is s3, specify the ARN of an S3 bucket. For example:

  arn:aws:s3:::my_bucket/my_subfolder/

  The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.

• If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:

  arn:aws:firehose:region:account_id:deliverystream:my_stream

Parameters:

logDestination - The destination for the flow log data. The meaning of this parameter depends on the destination type.

• If the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:

  arn:aws:logs:region:account_id:log-group:my_group

  Alternatively, use the LogGroupName parameter.

• If the destination type is s3, specify the ARN of an S3 bucket. For example:

  arn:aws:s3:::my_bucket/my_subfolder/

  The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.

• If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:

  arn:aws:firehose:region:account_id:deliverystream:my_stream

Returns:

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

setLogFormat

public void setLogFormat(String logFormat)

The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.

Specify the fields using the ${field-id} format, separated by spaces.

Parameters:

logFormat - The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.

Specify the fields using the ${field-id} format, separated by spaces.

getLogFormat

public String getLogFormat()

The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.

Specify the fields using the ${field-id} format, separated by spaces.

Returns:

The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.

Specify the fields using the ${field-id} format, separated by spaces.

withLogFormat

public CreateFlowLogsRequest withLogFormat(String logFormat)

The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.

Specify the fields using the ${field-id} format, separated by spaces.

Parameters:

logFormat - The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.

Specify the fields using the ${field-id} format, separated by spaces.

Returns:

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

getTagSpecifications

public List<TagSpecification> getTagSpecifications()

The tags to apply to the flow logs.

Returns:

The tags to apply to the flow logs.

setTagSpecifications

public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the flow logs.

Parameters:

tagSpecifications - The tags to apply to the flow logs.

withTagSpecifications

public CreateFlowLogsRequest withTagSpecifications(TagSpecification... tagSpecifications)

The tags to apply to the flow logs.

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

Parameters:

tagSpecifications - The tags to apply to the flow logs.

Returns:

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

withTagSpecifications

public CreateFlowLogsRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the flow logs.

Parameters:

tagSpecifications - The tags to apply to the flow logs.

Returns:

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

setMaxAggregationInterval

public void setMaxAggregationInterval(Integer maxAggregationInterval)

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.

When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

Default: 600

Parameters:

maxAggregationInterval - The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.

When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

Default: 600

getMaxAggregationInterval

public Integer getMaxAggregationInterval()

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.

When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

Default: 600

Returns:

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.

When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

Default: 600

withMaxAggregationInterval

public CreateFlowLogsRequest withMaxAggregationInterval(Integer maxAggregationInterval)

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.

When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

Default: 600

Parameters:

maxAggregationInterval - The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.

When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

Default: 600

Returns:

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

setDestinationOptions

public void setDestinationOptions(DestinationOptionsRequest destinationOptions)

The destination options.

Parameters:

destinationOptions - The destination options.

getDestinationOptions

public DestinationOptionsRequest getDestinationOptions()

The destination options.

Returns:

The destination options.

withDestinationOptions

public CreateFlowLogsRequest withDestinationOptions(DestinationOptionsRequest destinationOptions)

The destination options.

Parameters:

destinationOptions - The destination options.

Returns:

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

getDryRunRequest

public Request<CreateFlowLogsRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<CreateFlowLogsRequest>

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 CreateFlowLogsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()