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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
}

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html

Returns:

  • (String) 


4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
 
# File 'lib/aws-sdk-ec2/types.rb', line 4899

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_arn ⇒ String

The ARN for the IAM role that’s used to post flow logs to a log group.

Returns:

  • (String) 


4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
 
# File 'lib/aws-sdk-ec2/types.rb', line 4899

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_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) 


4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
 
# File 'lib/aws-sdk-ec2/types.rb', line 4899

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 ⇒ String

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:

  • (String) 


4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
 
# File 'lib/aws-sdk-ec2/types.rb', line 4899

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_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`.

Default: ‘cloud-watch-logs`

Returns:

  • (String) 


4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
 
# File 'lib/aws-sdk-ec2/types.rb', line 4899

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_name ⇒ String

The name of the log group.

Returns:

  • (String) 


4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
 
# File 'lib/aws-sdk-ec2/types.rb', line 4899

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_ids ⇒ Array<String>

One or more subnet, network interface, or VPC IDs.

Constraints: Maximum of 1000 resources

Returns:

  • (Array<String>) 


4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
 
# File 'lib/aws-sdk-ec2/types.rb', line 4899

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_type ⇒ String

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

Returns:

  • (String) 


4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
 
# File 'lib/aws-sdk-ec2/types.rb', line 4899

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_type ⇒ String

The type of traffic to log.

Returns:

  • (String) 


4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
 
# File 'lib/aws-sdk-ec2/types.rb', line 4899

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