NAME

Paws::EC2::CreateFlowLogs - Arguments for method CreateFlowLogs on Paws::EC2

DESCRIPTION

This class represents the parameters used for calling the method CreateFlowLogs on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method CreateFlowLogs.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFlowLogs.

SYNOPSIS

    my $ec2 = Paws->service('EC2');
    my $CreateFlowLogsResult = $ec2->CreateFlowLogs(
      ResourceIds              => [ 'MyFlowLogResourceId', ... ],
      ResourceType             => 'VPC',
      TrafficType              => 'ACCEPT',
      ClientToken              => 'MyString',                       # OPTIONAL
      DeliverLogsPermissionArn => 'MyString',                       # OPTIONAL
      DryRun                   => 1,                                # OPTIONAL
      LogDestination           => 'MyString',                       # OPTIONAL
      LogDestinationType       => 'cloud-watch-logs',               # OPTIONAL
      LogFormat                => 'MyString',                       # OPTIONAL
      LogGroupName             => 'MyString',                       # OPTIONAL
      MaxAggregationInterval   => 1,                                # OPTIONAL
      TagSpecifications        => [
        {
          ResourceType => 'client-vpn-endpoint'
          , # values: 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, network-insights-analysis, network-insights-path, 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-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log; OPTIONAL
          Tags => [
            {
              Key   => 'MyString',
              Value => 'MyString',
            },
            ...
          ],    # OPTIONAL
        },
        ...
      ],    # OPTIONAL
    );
    # Results:
    my $ClientToken  = $CreateFlowLogsResult->ClientToken;
    my $FlowLogIds   = $CreateFlowLogsResult->FlowLogIds;
    my $Unsuccessful = $CreateFlowLogsResult->Unsuccessful;
    # Returns a L<Paws::EC2::CreateFlowLogsResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ec2/CreateFlowLogs>

ATTRIBUTES

ClientToken => Str

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html).

DeliverLogsPermissionArn => Str

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

DryRun => Bool

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

LogDestination => Str

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.

LogDestinationType => Str

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"

Valid values are: "cloud-watch-logs", "s3"

LogFormat => Str

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 (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#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.

LogGroupName => Str

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

MaxAggregationInterval => Int

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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances), the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

Default: 600

REQUIRED ResourceIds => ArrayRef[Str|Undef]

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

Constraints: Maximum of 1000 resources

REQUIRED ResourceType => Str

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.

Valid values are: "VPC", "Subnet", "NetworkInterface"

TagSpecifications => ArrayRef[Paws::EC2::TagSpecification]

The tags to apply to the flow logs.

REQUIRED TrafficType => Str

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

Valid values are: "ACCEPT", "REJECT", "ALL"

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>