CreateFlowLogsRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.CreateFlowLogsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateFlowLogsRequest.Builder,CreateFlowLogsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFlowLogsRequest
extends Ec2Request
implements ToCopyableBuilder<CreateFlowLogsRequest.Builder,CreateFlowLogsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateFlowLogsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateFlowLogsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateFlowLogsRequest.Builder`	`builder()`
`String`	`clientToken()` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`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.
`DestinationOptionsRequest`	`destinationOptions()` The destination options.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasResourceIds()` For responses, this returns true if the service returned a value for the ResourceIds property.
`boolean`	`hasTagSpecifications()` For responses, this returns true if the service returned a value for the TagSpecifications property.
`String`	`logDestination()` The destination to which the flow log data is to be published.
`LogDestinationType`	`logDestinationType()` The type of destination to which the flow log data is to be published.
`String`	`logDestinationTypeAsString()` The type of destination to which the flow log data is to be published.
`String`	`logFormat()` The fields to include in the flow log record, in the order in which they should appear.
`String`	`logGroupName()` The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
`Integer`	`maxAggregationInterval()` The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
`List<String>`	`resourceIds()` The ID of the subnet, network interface, or VPC for which you want to create a flow log.
`FlowLogsResourceType`	`resourceType()` The type of resource for which to create the flow log.
`String`	`resourceTypeAsString()` The type of resource for which to create the flow log.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateFlowLogsRequest.Builder>`	`serializableBuilderClass()`
`List<TagSpecification>`	`tagSpecifications()` The tags to apply to the flow logs.
`CreateFlowLogsRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`TrafficType`	`trafficType()` The type of traffic to log.
`String`	`trafficTypeAsString()` The type of traffic to log.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clientToken
```
public final String clientToken()
```
    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.
  - deliverLogsPermissionArn
```
public final 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.
    
    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.
  - logGroupName
```
public final 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.
    
    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.
  - hasResourceIds
```
public final boolean hasResourceIds()
```
    For responses, this returns true if the service returned a value for the ResourceIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - resourceIds
```
public final List<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
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourceIds() method.
    
    Returns:
    
    The ID of the subnet, network interface, or VPC for which you want to create a flow log.
    
    Constraints: Maximum of 1000 resources
  - resourceType
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, resourceType will return FlowLogsResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().
    
    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
  - resourceTypeAsString
```
public final String resourceTypeAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, resourceType will return FlowLogsResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().
    
    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
  - trafficType
```
public final TrafficType trafficType()
```
    The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
    
    If the service returns an enum value that is not available in the current SDK version, trafficType will return TrafficType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trafficTypeAsString().
    
    Returns:
    
    The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
    
    See Also:
    
    TrafficType
  - trafficTypeAsString
```
public final String trafficTypeAsString()
```
    The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
    
    If the service returns an enum value that is not available in the current SDK version, trafficType will return TrafficType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trafficTypeAsString().
    
    Returns:
    
    The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
    
    See Also:
    
    TrafficType
  - logDestinationType
```
public final LogDestinationType logDestinationType()
```
    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
    
    If the service returns an enum value that is not available in the current SDK version, logDestinationType will return LogDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logDestinationTypeAsString().
    
    Returns:
    
    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
  - logDestinationTypeAsString
```
public final String logDestinationTypeAsString()
```
    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
    
    If the service returns an enum value that is not available in the current SDK version, logDestinationType will return LogDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logDestinationTypeAsString().
    
    Returns:
    
    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
  - logDestination
```
public final String logDestination()
```
    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:
    
    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.
  - logFormat
```
public final 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 CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.
    
    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 CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.
  - hasTagSpecifications
```
public final boolean hasTagSpecifications()
```
    For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tagSpecifications
```
public final List<TagSpecification> tagSpecifications()
```
    The tags to apply to the flow logs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.
    
    Returns:
    
    The tags to apply to the flow logs.
  - maxAggregationInterval
```
public final 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
    
    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
  - destinationOptions
```
public final DestinationOptionsRequest destinationOptions()
```
    The destination options.
    
    Returns:
    
    The destination options.
  - toBuilder
```
public CreateFlowLogsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateFlowLogsRequest.Builder,CreateFlowLogsRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static CreateFlowLogsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateFlowLogsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateFlowLogsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clientToken

deliverLogsPermissionArn

logGroupName

hasResourceIds

resourceIds

resourceType

resourceTypeAsString

trafficType

trafficTypeAsString

logDestinationType

logDestinationTypeAsString

logDestination

logFormat

hasTagSpecifications

tagSpecifications

maxAggregationInterval

destinationOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields