You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateFlowLogsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  dry_run: false,
  client_token: "String",
  deliver_logs_permission_arn: "String",
  log_group_name: "String",
  resource_ids: ["FlowLogResourceId"], # required
  resource_type: "VPC", # required, accepts VPC, Subnet, NetworkInterface
  traffic_type: "ACCEPT", # required, accepts ACCEPT, REJECT, ALL
  log_destination_type: "cloud-watch-logs", # accepts cloud-watch-logs, s3
  log_destination: "String",
  log_format: "String",
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  max_aggregation_interval: 1,
}

See Also:

Instance Attribute Summary collapse

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.

Returns:

  • (String) —

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

#deliver_logs_permission_arn ⇒ String

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:

  • (String) —

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

#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) —

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

#log_destination ⇒ String

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:

  • (String) —

    Specifies the destination to which the flow log data is to be published.

#log_destination_type ⇒ String

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

Possible values:

  • cloud-watch-logs
  • s3

Returns:

  • (String) —

    Specifies the type of destination to which the flow log data is to be published.

#log_format ⇒ String

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:

  • (String) —

    The fields to include in the flow log record, in the order in which they should appear.

#log_group_name ⇒ String

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:

  • (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. 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:

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

Constraints: Maximum of 1000 resources

Returns:

  • (Array<String>) —

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

#resource_type ⇒ String

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.

Possible values:

  • VPC
  • Subnet
  • NetworkInterface

Returns:

  • (String) —

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

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the flow logs.

Returns:

#traffic_type ⇒ String

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

Possible values:

  • ACCEPT
  • REJECT
  • ALL

Returns:

  • (String) —

    The type of traffic to log.