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	getDeliverLogsPermissionArn() The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
Request<CreateFlowLogsRequest>	getDryRunRequest() This method is intended for internal use only.
String	getLogDestination() Specifies the destination to which the flow log data is to be published.
String	getLogDestinationType() Specifies the type of destination to which the flow log data is to be published.
String	getLogFormat() The fields to include in the flow log record, in the order in which they should appear.
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 ID of the subnet, network interface, or VPC for which you want to create a flow log.
String	getResourceType() The type of resource for which to create the flow log.
List<TagSpecification>	getTagSpecifications() The tags to apply to the flow logs.
String	getTrafficType() The type of traffic to log.
int	hashCode()
void	setClientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setDeliverLogsPermissionArn(String deliverLogsPermissionArn) The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
void	setLogDestination(String logDestination) Specifies the destination to which the flow log data is to be published.
void	setLogDestinationType(LogDestinationType logDestinationType) Specifies the type of destination to which the flow log data is to be published.
void	setLogDestinationType(String logDestinationType) Specifies the type of destination to which the flow log data is to be published.
void	setLogFormat(String logFormat) The fields to include in the flow log record, in the order in which they should appear.
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 ID of the subnet, network interface, or VPC for which you want to create a flow log.
void	setResourceType(FlowLogsResourceType resourceType) The type of resource for which to create the flow log.
void	setResourceType(String resourceType) The type of resource for which to create the flow log.
void	setTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the flow logs.
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.
CreateFlowLogsRequest	withClientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateFlowLogsRequest	withDeliverLogsPermissionArn(String deliverLogsPermissionArn) The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
CreateFlowLogsRequest	withLogDestination(String logDestination) Specifies the destination to which the flow log data is to be published.
CreateFlowLogsRequest	withLogDestinationType(LogDestinationType logDestinationType) Specifies the type of destination to which the flow log data is to be published.
CreateFlowLogsRequest	withLogDestinationType(String logDestinationType) Specifies the type of destination to which the flow log data is to be published.
CreateFlowLogsRequest	withLogFormat(String logFormat) The fields to include in the flow log record, in the order in which they should appear.
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 ID of the subnet, network interface, or VPC for which you want to create a flow log.
CreateFlowLogsRequest	withResourceIds(String... resourceIds) The ID of the subnet, network interface, or VPC for which you want to create a flow log.
CreateFlowLogsRequest	withResourceType(FlowLogsResourceType resourceType) The type of resource for which to create the flow log.
CreateFlowLogsRequest	withResourceType(String resourceType) The type of resource for which to create the flow log.
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 log.
CreateFlowLogsRequest	withTrafficType(TrafficType trafficType) The type of traffic to log.

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 for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Parameters:

deliverLogsPermissionArn - The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

getDeliverLogsPermissionArn

public String getDeliverLogsPermissionArn()

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Returns:

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

withDeliverLogsPermissionArn

public CreateFlowLogsRequest withDeliverLogsPermissionArn(String deliverLogsPermissionArn)

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Parameters:

deliverLogsPermissionArn - The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

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.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Parameters:

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

getLogGroupName

public String getLogGroupName()

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Returns:

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

withLogGroupName

public CreateFlowLogsRequest withLogGroupName(String logGroupName)

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Parameters:

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Returns:

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

getResourceIds

public List<String> getResourceIds()

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Returns:

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

setResourceIds

public void setResourceIds(Collection<String> resourceIds)

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Parameters:

resourceIds - The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

withResourceIds

public CreateFlowLogsRequest withResourceIds(String... resourceIds)

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

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 ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Returns:

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

withResourceIds

public CreateFlowLogsRequest withResourceIds(Collection<String> resourceIds)

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Parameters:

resourceIds - The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

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 for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

Parameters:

resourceType - The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

See Also:

FlowLogsResourceType

getResourceType

public String getResourceType()

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

Returns:

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

See Also:

FlowLogsResourceType

withResourceType

public CreateFlowLogsRequest withResourceType(String resourceType)

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

Parameters:

resourceType - The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

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 for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

Parameters:

resourceType - The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

See Also:

FlowLogsResourceType

withResourceType

public CreateFlowLogsRequest withResourceType(FlowLogsResourceType resourceType)

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

Parameters:

resourceType - The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

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 log. You can log traffic that the resource accepts or rejects, or all traffic.

Parameters:

trafficType - The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

See Also:

TrafficType

getTrafficType

public String getTrafficType()

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

Returns:

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

See Also:

TrafficType

withTrafficType

public CreateFlowLogsRequest withTrafficType(String trafficType)

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

Parameters:

trafficType - The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

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 log. You can log traffic that the resource accepts or rejects, or all traffic.

Parameters:

trafficType - The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

See Also:

TrafficType

withTrafficType

public CreateFlowLogsRequest withTrafficType(TrafficType trafficType)

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

Parameters:

trafficType - The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

Returns:

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

See Also:

TrafficType

setLogDestinationType

public void setLogDestinationType(String logDestinationType)

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

Parameters:

logDestinationType - Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

See Also:

LogDestinationType

getLogDestinationType

public String getLogDestinationType()

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

Returns:

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

See Also:

LogDestinationType

withLogDestinationType

public CreateFlowLogsRequest withLogDestinationType(String logDestinationType)

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

Parameters:

logDestinationType - Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

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)

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

Parameters:

logDestinationType - Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

See Also:

LogDestinationType

withLogDestinationType

public CreateFlowLogsRequest withLogDestinationType(LogDestinationType logDestinationType)

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

Parameters:

logDestinationType - Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

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)

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

Parameters:

logDestination - Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/ . You cannot use AWSLogs as a subfolder name. This is a reserved term.

getLogDestination

public String getLogDestination()

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

Returns:

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

withLogDestination

public CreateFlowLogsRequest withLogDestination(String logDestination)

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

Parameters:

logDestination - Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/ . You cannot use AWSLogs as a subfolder name. This is a reserved term.

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, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

Parameters:

logFormat - The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

getLogFormat

public String getLogFormat()

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

Returns:

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

withLogFormat

public CreateFlowLogsRequest withLogFormat(String logFormat)

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

Parameters:

logFormat - The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

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. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

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. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

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. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

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. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

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. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

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. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

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.

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