Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Class CfnFlowLogMixinProps.Builder

java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnFlowLogMixinProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnFlowLogMixinProps>
Enclosing interface:
CfnFlowLogMixinProps
@Stability(Stable) public static final class CfnFlowLogMixinProps.Builder extends Object implements software.amazon.jsii.Builder<CfnFlowLogMixinProps>
A builder for CfnFlowLogMixinProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • deliverCrossAccountRole

      @Stability(Stable) public CfnFlowLogMixinProps.Builder deliverCrossAccountRole(String deliverCrossAccountRole)
      Sets the value of CfnFlowLogMixinProps.getDeliverCrossAccountRole()
      Parameters:
      deliverCrossAccountRole - The ARN of the IAM role that allows the service to publish flow logs across accounts.
      Returns:
      this

    • deliverLogsPermissionArn

      @Stability(Stable) public CfnFlowLogMixinProps.Builder deliverLogsPermissionArn(String deliverLogsPermissionArn)
      Sets the value of CfnFlowLogMixinProps.getDeliverLogsPermissionArn()
      Parameters:
      deliverLogsPermissionArn - The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination. This parameter is required if the destination type is cloud-watch-logs , or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.
      Returns:
      this

    • deliverLogsPermissionArn

      @Stability(Stable) public CfnFlowLogMixinProps.Builder deliverLogsPermissionArn(IRoleRef deliverLogsPermissionArn)
      Sets the value of CfnFlowLogMixinProps.getDeliverLogsPermissionArn()
      Parameters:
      deliverLogsPermissionArn - The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination. This parameter is required if the destination type is cloud-watch-logs , or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.
      Returns:
      this

    • destinationOptions

      @Stability(Stable) public CfnFlowLogMixinProps.Builder destinationOptions(Object destinationOptions)
      Sets the value of CfnFlowLogMixinProps.getDestinationOptions()
      Parameters:
      destinationOptions - The destination options.
      Returns:
      this

    • logDestination

      @Stability(Stable) public CfnFlowLogMixinProps.Builder logDestination(String logDestination)
      Sets the value of CfnFlowLogMixinProps.getLogDestination()
      Parameters:
      logDestination - 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

      Returns:
      this

    • logDestination

      @Stability(Stable) public CfnFlowLogMixinProps.Builder logDestination(ILogGroupRef logDestination)
      Sets the value of CfnFlowLogMixinProps.getLogDestination()
      Parameters:
      logDestination - 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

      Returns:
      this

    • logDestination

      @Stability(Stable) public CfnFlowLogMixinProps.Builder logDestination(IBucketRef logDestination)
      Sets the value of CfnFlowLogMixinProps.getLogDestination()
      Parameters:
      logDestination - 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

      Returns:
      this

    • logDestinationType

      @Stability(Stable) public CfnFlowLogMixinProps.Builder logDestinationType(String logDestinationType)
      Sets the value of CfnFlowLogMixinProps.getLogDestinationType()
      Parameters:
      logDestinationType - The type of destination for the flow log data. Default: cloud-watch-logs
      Returns:
      this

    • logFormat

      @Stability(Stable) public CfnFlowLogMixinProps.Builder logFormat(String logFormat)
      Sets the value of CfnFlowLogMixinProps.getLogFormat()
      Parameters:
      logFormat - The fields to include in the flow log record, 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 AWS Transit Gateway Guide .

      Specify the fields using the ${field-id} format, separated by spaces.

      Returns:
      this

    • logGroupName

      @Stability(Stable) public CfnFlowLogMixinProps.Builder logGroupName(String logGroupName)
      Sets the value of CfnFlowLogMixinProps.getLogGroupName()
      Parameters:
      logGroupName - 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 .
      Returns:
      this

    • logGroupName

      @Stability(Stable) public CfnFlowLogMixinProps.Builder logGroupName(ILogGroupRef logGroupName)
      Sets the value of CfnFlowLogMixinProps.getLogGroupName()
      Parameters:
      logGroupName - 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 .
      Returns:
      this

    • maxAggregationInterval

      @Stability(Stable) public CfnFlowLogMixinProps.Builder maxAggregationInterval(Number maxAggregationInterval)
      Sets the value of CfnFlowLogMixinProps.getMaxAggregationInterval()
      Parameters:
      maxAggregationInterval - 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

      Returns:
      this

    • resourceId

      @Stability(Stable) public CfnFlowLogMixinProps.Builder resourceId(String resourceId)
      Sets the value of CfnFlowLogMixinProps.getResourceId()
      Parameters:
      resourceId - The ID of the resource to monitor. For example, if the resource type is VPC , specify the ID of the VPC.
      Returns:
      this

    • resourceId

      @Stability(Stable) public CfnFlowLogMixinProps.Builder resourceId(ISubnetRef resourceId)
      Sets the value of CfnFlowLogMixinProps.getResourceId()
      Parameters:
      resourceId - The ID of the resource to monitor. For example, if the resource type is VPC , specify the ID of the VPC.
      Returns:
      this

    • resourceId

      @Stability(Stable) public CfnFlowLogMixinProps.Builder resourceId(ITransitGatewayRef resourceId)
      Sets the value of CfnFlowLogMixinProps.getResourceId()
      Parameters:
      resourceId - The ID of the resource to monitor. For example, if the resource type is VPC , specify the ID of the VPC.
      Returns:
      this

    • resourceId

      @Stability(Stable) public CfnFlowLogMixinProps.Builder resourceId(IVPCRef resourceId)
      Sets the value of CfnFlowLogMixinProps.getResourceId()
      Parameters:
      resourceId - The ID of the resource to monitor. For example, if the resource type is VPC , specify the ID of the VPC.
      Returns:
      this

    • resourceType

      @Stability(Stable) public CfnFlowLogMixinProps.Builder resourceType(String resourceType)
      Sets the value of CfnFlowLogMixinProps.getResourceType()
      Parameters:
      resourceType - The type of resource to monitor.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnFlowLogMixinProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnFlowLogMixinProps.getTags()
      Parameters:
      tags - The tags to apply to the flow logs.
      Returns:
      this

    • trafficType

      @Stability(Stable) public CfnFlowLogMixinProps.Builder trafficType(String trafficType)
      Sets the value of CfnFlowLogMixinProps.getTrafficType()
      Parameters:
      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.
      Returns:
      this

    • build

      @Stability(Stable) public CfnFlowLogMixinProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnFlowLogMixinProps>
      Returns:
      a new instance of CfnFlowLogMixinProps
      Throws:
      NullPointerException - if any required attribute was not provided