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>

Contains the parameters for CreateFlowLogs.

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's used to post flow logs to a log group.
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	getLogGroupName() The name of the 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 that 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 log group.
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	setLogGroupName(String logGroupName) The name of the 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 that 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 log group.
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	withLogGroupName(String logGroupName) The name of the 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

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's used to post flow logs to a log group.

Parameters:

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

getDeliverLogsPermissionArn

public String getDeliverLogsPermissionArn()

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

Returns:

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

withDeliverLogsPermissionArn

public CreateFlowLogsRequest withDeliverLogsPermissionArn(String deliverLogsPermissionArn)

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

Parameters:

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

Returns:

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

setLogGroupName

public void setLogGroupName(String logGroupName)

The name of the log group.

Parameters:

logGroupName - The name of the log group.

getLogGroupName

public String getLogGroupName()

The name of the log group.

Returns:

The name of the log group.

withLogGroupName

public CreateFlowLogsRequest withLogGroupName(String logGroupName)

The name of the log group.

Parameters:

logGroupName - The name of the log group.

Returns:

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

getResourceIds

public List<String> getResourceIds()

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

Constraints: Maximum of 1000 resources

Returns:

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

Constraints: Maximum of 1000 resources

setResourceIds

public void setResourceIds(Collection<String> resourceIds)

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

Constraints: Maximum of 1000 resources

Parameters:

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

Constraints: Maximum of 1000 resources

withResourceIds

public CreateFlowLogsRequest withResourceIds(String... resourceIds)

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

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 - One or more subnet, network interface, or VPC IDs.

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)

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

Constraints: Maximum of 1000 resources

Parameters:

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

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 on which to create the flow log.

Parameters:

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

See Also:

FlowLogsResourceType

getResourceType

public String getResourceType()

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

Returns:

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.

Parameters:

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

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 on which to create the flow log.

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.

Parameters:

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

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.

Parameters:

trafficType - The type of traffic to log.

See Also:

TrafficType

getTrafficType

public String getTrafficType()

The type of traffic to log.

Returns:

The type of traffic to log.

See Also:

TrafficType

withTrafficType

public CreateFlowLogsRequest withTrafficType(String trafficType)

The type of traffic to log.

Parameters:

trafficType - The type of traffic to log.

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.

Parameters:

trafficType - The type of traffic to log.

See Also:

TrafficType

withTrafficType

public CreateFlowLogsRequest withTrafficType(TrafficType trafficType)

The type of traffic to log.

Parameters:

trafficType - The type of traffic to log.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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 an 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.

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/.

Parameters:

logDestination - Specifies the destination to which the flow log data is to be published. Flow log data can be published to an 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.

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/.

getLogDestination

public String getLogDestination()

Specifies the destination to which the flow log data is to be published. Flow log data can be published to an 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.

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/.

Returns:

Specifies the destination to which the flow log data is to be published. Flow log data can be published to an 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.

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/.

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 an 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.

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/.

Parameters:

logDestination - Specifies the destination to which the flow log data is to be published. Flow log data can be published to an 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.

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/.

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; useful for testing and debugging.

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