CreateFlowLogsRequest (AWS SDK for Java

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's used to post flow logs to a log group.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`logDestination()` Specifies the destination to which the flow log data is to be published.
`LogDestinationType`	`logDestinationType()` Specifies the type of destination to which the flow log data is to be published.
`String`	`logDestinationTypeAsString()` Specifies the type of destination to which the flow log data is to be published.
`String`	`logGroupName()` The name of the log group.
`List<String>`	`resourceIds()` One or more subnet, network interface, or VPC IDs.
`FlowLogsResourceType`	`resourceType()` The type of resource on which to create the flow log.
`String`	`resourceTypeAsString()` The type of resource on which to create the flow log.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateFlowLogsRequest.Builder>`	`serializableBuilderClass()`
`CreateFlowLogsRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`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
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - clientToken
```
public 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 String deliverLogsPermissionArn()
```
    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.
  - logGroupName
```
public String logGroupName()
```
    The name of the log group.
    
    Returns:
    
    The name of the log group.
  - resourceIds
```
public List<String> resourceIds()
```
    One or more subnet, network interface, or VPC IDs.
    
    Constraints: Maximum of 1000 resources
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    One or more subnet, network interface, or VPC IDs.
    
    Constraints: Maximum of 1000 resources
  - resourceType
```
public FlowLogsResourceType resourceType()
```
    The type of resource on which to create the flow log.
    
    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 on which to create the flow log.
    
    See Also:
    
    FlowLogsResourceType
  - resourceTypeAsString
```
public String resourceTypeAsString()
```
    The type of resource on which to create the flow log.
    
    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 on which to create the flow log.
    
    See Also:
    
    FlowLogsResourceType
  - trafficType
```
public TrafficType trafficType()
```
    The type of traffic to log.
    
    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.
    
    See Also:
    
    TrafficType
  - trafficTypeAsString
```
public String trafficTypeAsString()
```
    The type of traffic to log.
    
    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.
    
    See Also:
    
    TrafficType
  - logDestinationType
```
public 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
    
    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:
    
    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
  - logDestinationTypeAsString
```
public String logDestinationTypeAsString()
```
    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
    
    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:
    
    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
  - logDestination
```
public 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/. 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 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/. You cannot use AWSLogs as a subfolder name. This is a reserved term.
  - toBuilder
```
public CreateFlowLogsRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateFlowLogsRequest.Builder,CreateFlowLogsRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateFlowLogsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateFlowLogsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

resourceIds

resourceType

resourceTypeAsString

trafficType

trafficTypeAsString

logDestinationType

logDestinationTypeAsString

logDestination

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields