Class: Aws::EC2::Types::CreateFlowLogsRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::CreateFlowLogsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #deliver_cross_account_role ⇒ String

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

• #deliver_logs_permission_arn ⇒ String

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

• #destination_options ⇒ Types::DestinationOptionsRequest

  The destination options.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #log_destination ⇒ String

  The destination for the flow log data.

• #log_destination_type ⇒ String

  The type of destination for the flow log data.

• #log_format ⇒ String

  The fields to include in the flow log record.

• #log_group_name ⇒ String

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

• #max_aggregation_interval ⇒ Integer

  The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.

• #resource_ids ⇒ Array<String>

  The IDs of the resources to monitor.

• #resource_type ⇒ String

  The type of resource to monitor.

• #tag_specifications ⇒ Array<Types::TagSpecification>

  The tags to apply to the flow logs.

• #traffic_type ⇒ String

  The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).

Instance Attribute Details

#client_token ⇒ String

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

[1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end

#deliver_cross_account_role ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end

#deliver_logs_permission_arn ⇒ String

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:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end

#destination_options ⇒ Types::DestinationOptionsRequest

The destination options.

Returns:

• (Types::DestinationOptionsRequest)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end

#log_destination ⇒ String

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:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end

#log_destination_type ⇒ String

The type of destination for the flow log data.

Default: ‘cloud-watch-logs`

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end

#log_format ⇒ String

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.

[1]: docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records [2]: docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_name ⇒ String

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:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end

#max_aggregation_interval ⇒ Integer

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

[1]: docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end

#resource_ids ⇒ Array<String>

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:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The type of resource to monitor.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the flow logs.

Returns:

• (Array<Types::TagSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_type ⇒ String

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:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 8152

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :deliver_cross_account_role,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination,
  :log_format,
  :tag_specifications,
  :max_aggregation_interval,
  :destination_options)
  SENSITIVE = []
  include Aws::Structure
end