Struct aws_sdk_ec2::operation::create_flow_logs::CreateFlowLogsInput

#[non_exhaustive]
pub struct CreateFlowLogsInput {

    pub dry_run: Option<bool>,
    pub client_token: Option<String>,
    pub deliver_logs_permission_arn: Option<String>,
    pub deliver_cross_account_role: Option<String>,
    pub log_group_name: Option<String>,
    pub resource_ids: Option<Vec<String>>,
    pub resource_type: Option<FlowLogsResourceType>,
    pub traffic_type: Option<TrafficType>,
    pub log_destination_type: Option<LogDestinationType>,
    pub log_destination: Option<String>,
    pub log_format: Option<String>,
    pub tag_specifications: Option<Vec<TagSpecification>>,
    pub max_aggregation_interval: Option<i32>,
    pub destination_options: Option<DestinationOptionsRequest>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

dry_run: Option<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.

client_token: Option<String>

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

deliver_logs_permission_arn: Option<String>

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

This parameter is required if the destination type is cloud-watch-logs and unsupported otherwise.

deliver_cross_account_role: Option<String>

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

log_group_name: Option<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.

resource_ids: Option<Vec<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.

resource_type: Option<FlowLogsResourceType>

The type of resource to monitor.

traffic_type: Option<TrafficType>

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.

log_destination_type: Option<LogDestinationType>

The type of destination for the flow log data.

Default: cloud-watch-logs

log_destination: Option<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

log_format: Option<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.

tag_specifications: Option<Vec<TagSpecification>>

The tags to apply to the flow logs.

max_aggregation_interval: Option<i32>

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

destination_options: Option<DestinationOptionsRequest>

The destination options.

Implementations

impl CreateFlowLogsInput

pub fn dry_run(&self) -> Option<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.

pub fn client_token(&self) -> Option<&str>

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

pub fn deliver_logs_permission_arn(&self) -> Option<&str>

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

This parameter is required if the destination type is cloud-watch-logs and unsupported otherwise.

pub fn deliver_cross_account_role(&self) -> Option<&str>

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

pub fn log_group_name(&self) -> Option<&str>

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.

pub fn resource_ids(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_ids.is_none().

pub fn resource_type(&self) -> Option<&FlowLogsResourceType>

The type of resource to monitor.

pub fn traffic_type(&self) -> Option<&TrafficType>

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.

pub fn log_destination_type(&self) -> Option<&LogDestinationType>

The type of destination for the flow log data.

Default: cloud-watch-logs

pub fn log_destination(&self) -> Option<&str>

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

pub fn log_format(&self) -> Option<&str>

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.

pub fn tag_specifications(&self) -> &[TagSpecification]

The tags to apply to the flow logs.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tag_specifications.is_none().

pub fn max_aggregation_interval(&self) -> Option<i32>

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

pub fn destination_options(&self) -> Option<&DestinationOptionsRequest>

The destination options.

impl CreateFlowLogsInput

pub fn builder() -> CreateFlowLogsInputBuilder

Creates a new builder-style object to manufacture CreateFlowLogsInput.

Trait Implementations

impl Clone for CreateFlowLogsInput

fn clone(&self) -> CreateFlowLogsInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateFlowLogsInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateFlowLogsInput

fn eq(&self, other: &CreateFlowLogsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateFlowLogsInput