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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CreateFlowLogsRequest data as a hash:

{
  dry_run: false,
  client_token: "String",
  deliver_logs_permission_arn: "String",
  log_group_name: "String",
  resource_ids: ["String"], # 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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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

Returns:

  • (String)


5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5003

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination)
  include Aws::Structure
end

#deliver_logs_permission_arnString

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)


5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5003

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination)
  include Aws::Structure
end

#dry_runBoolean

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)


5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5003

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination)
  include Aws::Structure
end

#log_destinationString

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.

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)


5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5003

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination)
  include Aws::Structure
end

#log_destination_typeString

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

Returns:

  • (String)


5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5003

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination)
  include Aws::Structure
end

#log_group_nameString

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)


5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5003

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination)
  include Aws::Structure
end

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


5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5003

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination)
  include Aws::Structure
end

#resource_typeString

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.

Returns:

  • (String)


5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5003

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination)
  include Aws::Structure
end

#traffic_typeString

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

Returns:

  • (String)


5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5003

class CreateFlowLogsRequest < Struct.new(
  :dry_run,
  :client_token,
  :deliver_logs_permission_arn,
  :log_group_name,
  :resource_ids,
  :resource_type,
  :traffic_type,
  :log_destination_type,
  :log_destination)
  include Aws::Structure
end